Skip to content

Commit

Permalink
Merge d1c5689 into d449189
Browse files Browse the repository at this point in the history
  • Loading branch information
ltfschoen committed Oct 15, 2018
2 parents d449189 + d1c5689 commit 7bae445
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
5 changes: 3 additions & 2 deletions README.md
Expand Up @@ -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 -

Expand Down
4 changes: 2 additions & 2 deletions 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)
2 changes: 1 addition & 1 deletion packages/api-observable/src/Combined.ts
Expand Up @@ -13,7 +13,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 {
Expand Down

0 comments on commit 7bae445

Please sign in to comment.