quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bump dev, update docs (#36)

Browse Source
This commit is contained in:
Jaco Greeff
2017-12-07 22:12:34 +01:00
committed by GitHub
parent 365a6ed87a
commit eb9283c553
3 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
package.json
+1 -1
View File
@@ -10,7 +10,7 @@
"test": "jest --coverage" "test": "jest --coverage"
}, },
"devDependencies": { "devDependencies": {
"@polkadot/dev": "^0.13.1", "@polkadot/dev": "^0.13.3",
"lerna": "^2.5.1" "lerna": "^2.5.1"
} }
} }
packages/api-jsonrpc/README.md
+2 -2
View File
@@ -5,6 +5,8 @@
A defintion of all the methods exposed in a general Polkadot client application. These are used not only to provide a comprehensive code-generated document of the available methods, but are also used in the API to auto-generate endpoints with the required type-checking. A defintion of all the methods exposed in a general Polkadot client application. These are used not only to provide a comprehensive code-generated document of the available methods, but are also used in the API to auto-generate endpoints with the required type-checking.
For a list of currently exposed methods, see the [method documentation](docs/README.md).
## Usage ## Usage
Installation - Installation -
@@ -13,8 +15,6 @@ Installation -
npm install --save @polkadot/api-jsonrpc npm install --save @polkadot/api-jsonrpc
``` ```
For a list of currently exposed methods, see the [method documentation](docs/README.md).
## Adding methods ## Adding methods
As methods are added, simply adding the name, inputs & output will prepare it for use. As methods are added, simply adding the name, inputs & output will prepare it for use.
packages/api/README.md
+3 -5
View File
@@ -3,7 +3,9 @@
# @polkadot/api # @polkadot/api
Warning - currently this does not actually do all that much, it is an attempt to put into code some thoughts about how to maintain the endpoints. This library provides a clean wrapper around all the methods exposed by a Polkadot network client. Methods are auto-generated for the [JsonRPC interface definitions](https://github.com/polkadot-js/api/packages/api-jsonrpc). Warning - currently this does not actually do all that much, it is an attempt to put into code some thoughts about how to maintain the endpoints. This library provides a clean wrapper around all the methods exposed by a Polkadot network client.
Methods are auto-generated for the [JsonRPC interface definitions](../api-jsonrpc#readme), containing a full list of all sections and the methods cotained within.
## Usage ## Usage
@@ -31,7 +33,3 @@ api.chain
.then((header) => console.log(header)) .then((header) => console.log(header))
.catch((error) => console.error(error)); .catch((error) => console.error(error));
``` ```
## Available methods
For a list of currently exposed methods, see the [@polkadot/api-jsonrpc](https://github.com/polkadot-js/api/packages/api-jsonrpc#readme) repository.