From 89513e521653bdb73a05d824f41a659a3a27cb9f Mon Sep 17 00:00:00 2001 From: platfowner Date: Tue, 26 Nov 2024 10:49:09 +0900 Subject: [PATCH 1/2] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 56c6ee6..3cec52c 100644 --- a/README.md +++ b/README.md @@ -34,17 +34,20 @@ const accounts = ain.db.ref('/accounts').getValue().then(result => { ``` ## Test How-To +For testing, you need a blockchain node cluster running locally. 1. Clone AIN Blockchain and install ``` git clone git@github.com:ainblockchain/ain-blockchain.git +cd ain-blockchain yarn install ``` 2. Start blockchain locally ``` +cd ain-blockchain bash start_local_blockchain.sh ``` - * Note that the node 2 of the blockchain needs to be started with ENABLE_EVENT_HANDLER=true env variable for the event manager test cases. +* Note that the node 2 of the blockchain needs to be started with ENABLE_EVENT_HANDLER=true env variable for the event manager test cases. 3. Run tests ``` From 6945113b5c8f97f616f36ca0fdaa0109f8be6b16 Mon Sep 17 00:00:00 2001 From: platfowner Date: Tue, 26 Nov 2024 10:53:06 +0900 Subject: [PATCH 2/2] Move API doc link to the front --- README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3cec52c..6de5565 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # ain-js - AI Network Blockchain SDK for javascript (or typescript). +## API Documentation +API documentation is available at https://ainblockchain.github.io/ain-js/. ## Installation ``` yarn add @ainblockchain/ain-js ``` - ## Examples ``` const Ain = require('./lib/ain').default; @@ -55,11 +55,6 @@ yarn run test yarn run test_snapshot # update test snapshot files ``` - -## API Documentation - -API documentation is available at https://ainblockchain.github.io/ain-js/. - ## LICENSE MPL-2.0