From b2c512fc8c3f411253cd72c4ed7a4e4246bf9202 Mon Sep 17 00:00:00 2001 From: Luke Schoen Date: Mon, 15 Oct 2018 23:15:19 +0200 Subject: [PATCH] fix: Change Readme contents to reflect implementation (#287) * fix: Change Readme contents to reflect implementation * Update README.md --- README.md | 5 +++-- packages/api-observable/README.md | 4 ++-- packages/api-observable/src/Combined.ts | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index efa0a3c958..2c71f10427 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,10 @@ This library provides a clean wrapper around all the methods exposed by a Polkad The API is split up into a number of internal packages - - [@polkadot/api](packages/api/) The API library, providing both Promise and RxJS Observable-based interfaces -- [@polkadot/api-observable](packages/api-observable/) A combination Observable wrapper around [@polkadot/api/rx](packages/api/rs) -- [@polkadot/rpc-core](packages/rpc-core/) Wrapper around all methods exposed by a Polkadot network client +- [@polkadot/api-observable](packages/api-observable/) A combination Observable wrapper around [@polkadot/rpc-rx](packages/rpc-rx), including both [JSON-RPC methods](https://polkadot.js.org/api/METHODS_RPC.html) and [Storage methods](https://polkadot.js.org/api/METHODS_STORAGE.html) +- [@polkadot/rpc-core](packages/rpc-core/) Wrapper around all [JSON-RPC methods](https://polkadot.js.org/api/METHODS_RPC.html) exposed by a Polkadot network client - [@polkadot/rpc-provider](packages/rpc-provider/) Providers for connecting to nodes, including WebSockets and Http +- [@polkadot/rpc-rx](packages/rpc-rx/) A RxJs Observable wrapper around [@polkadot/rpc-provider](packages/rpc-provider) Type definitions for interfaces as exposed by Polkadot & Substrate clients - diff --git a/packages/api-observable/README.md b/packages/api-observable/README.md index be31559c47..aeebe8519d 100644 --- a/packages/api-observable/README.md +++ b/packages/api-observable/README.md @@ -1,3 +1,3 @@ -# @polkadot/api +# @polkadot/api-observable -An Observable wrapper around [@polkadot/rpc-core](../rpc-core). +A combination Observable wrapper around [@polkadot/rpc-rx](packages/rpc-rx), including both [JSON-RPC methods](https://polkadot.js.org/api/METHODS_RPC.html) and [Storage methods](https://polkadot.js.org/api/METHODS_STORAGE.html) diff --git a/packages/api-observable/src/Combined.ts b/packages/api-observable/src/Combined.ts index f65c3ad882..26ff851aad 100644 --- a/packages/api-observable/src/Combined.ts +++ b/packages/api-observable/src/Combined.ts @@ -14,7 +14,7 @@ import isString from '@polkadot/util/is/string'; import ApiCalls from './Calls'; import { RxProposal, RxReferendum } from './classes'; -// Combines API calls and queries into single results. This allos for the exposed API to have +// Combines API calls and queries into single results. This allows for the exposed API to have // useful extensions, i.e. queries can be made that returns the results from multiple observables, // make the noise for the API users significantly less export default class ApiCombined extends ApiCalls {