Skip to content

Commit

Permalink
Merge pull request #209 from ainblockchain/feature/platfowner/feature
Browse files Browse the repository at this point in the history
Tweak README.md
  • Loading branch information
platfowner authored Nov 26, 2024
2 parents e1c5d17 + 6945113 commit 52704e7
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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;
Expand All @@ -34,29 +34,27 @@ 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 [email protected]: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
```
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

0 comments on commit 52704e7

Please sign in to comment.