From eb9283c55374bbb4d3e1d7da5c5ce6c0fe03e4db Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Thu, 7 Dec 2017 22:12:34 +0100 Subject: [PATCH] Bump dev, update docs (#36) --- package.json | 2 +- packages/api-jsonrpc/README.md | 4 ++-- packages/api/README.md | 8 +++----- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/package.json b/package.json index a7c24f9439..8dde6509ca 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "test": "jest --coverage" }, "devDependencies": { - "@polkadot/dev": "^0.13.1", + "@polkadot/dev": "^0.13.3", "lerna": "^2.5.1" } } diff --git a/packages/api-jsonrpc/README.md b/packages/api-jsonrpc/README.md index 12f0bd5652..bf58b1aaab 100644 --- a/packages/api-jsonrpc/README.md +++ b/packages/api-jsonrpc/README.md @@ -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. +For a list of currently exposed methods, see the [method documentation](docs/README.md). + ## Usage Installation - @@ -13,8 +15,6 @@ Installation - npm install --save @polkadot/api-jsonrpc ``` -For a list of currently exposed methods, see the [method documentation](docs/README.md). - ## Adding methods As methods are added, simply adding the name, inputs & output will prepare it for use. diff --git a/packages/api/README.md b/packages/api/README.md index 59672baf8b..01fc0e1bc8 100644 --- a/packages/api/README.md +++ b/packages/api/README.md @@ -3,7 +3,9 @@ # @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 @@ -31,7 +33,3 @@ api.chain .then((header) => console.log(header)) .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.