Skip to content

Commit

Permalink
Merge pull request #1 from aionnetwork/documentation
Browse files Browse the repository at this point in the history
minor updates to README.md
  • Loading branch information
aion-6368726973 authored Feb 2, 2018
2 parents a8ace48 + d457730 commit cb641ff
Showing 1 changed file with 12 additions and 17 deletions.
29 changes: 12 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,17 @@ This project contains tools for using the Web3 application programming interface

## Requirements

* **Node.js** version 8.9.1
* **Node.js** version 8.9.1 <br/>
Download: https://nodejs.org/en/download/ <br/>
Check version by running `node -v` in a terminal.

Download: https://nodejs.org/en/download/
* **npm** version 5.5.1 <br/>
Typically included with node installation. <br/>
Check version by running `npm -v` in a terminal.

Check version by running `node -v` in a terminal.

* **npm** version 5.5.1

Typically included with node installation.

Check version by running `npm -v` in a terminal.

* **gulp** version 3.9.1

Installation: https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md

Check version by running `guilp -v` in a terminal.
* **gulp** version 3.9.1 <br/>
Installation: https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md <br/>
Check version by running `gulp -v` in a terminal.

**Note:** Other versions may work, but have not been thoroughly tested at present.

Expand All @@ -40,9 +34,10 @@ or
npm install --save aion-web3
```

## Usage
## API Use

This application programming interface can be used to perform different operation on the Aion blockchain.
Some example uses cases are available in the project wiki.
Some example uses cases are available in the project [wiki](https://github.com/aionnetwork/aion_web3/wiki).

* Web use: include `dist/web3.min.js` in your html file
* Node use: `var Web3 = require('aion-web3')`
Expand Down

0 comments on commit cb641ff

Please sign in to comment.