From 3e20e7b10d6addc7e49234f03fbf05ab666e21d8 Mon Sep 17 00:00:00 2001 From: Luke Schoen Date: Sun, 14 Oct 2018 09:32:51 +0200 Subject: [PATCH] docs: Fixes #275. Update Readme package names and links (#286) * docs: Fixes #275. Update Readme package names and links * Update README.md --- README.md | 11 ++++++----- packages/type-extrinsics/README.md | 2 ++ 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d3c4da126e..efa0a3c958 100644 --- a/README.md +++ b/README.md @@ -17,16 +17,17 @@ 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 low-level base API library -- [@polkadot/api-codec](packages/api-codec/) Codecs for all Polkadot primitives -- [@polkadot/api-rx](packages/api-rx/) A RxJs Observable wrapper around the API -- [@polkadot/api-provider](packages/api-provider/) Providers for connecting +- [@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/rpc-provider](packages/rpc-provider/) Providers for connecting to nodes, including WebSockets and Http Type definitions for interfaces as exposed by Polkadot & Substrate clients - - [@polkadot/extrinsics](packages/type-extrinsics/) Base extrinsic definitions & codecs - [@polkadot/jsonrpc](packages/type-jsonrpc/) Definitions for JSONRPC endpoints - [@polkadot/storage](packages/type-storage/) Definitions for storage entries +- [@polkadot/types](packages/types/) Codecs for all Polkadot primitives ## development @@ -46,4 +47,4 @@ To get started - ## tutorials -Looking for tutorials to get started? Look at [examples](https://polkadot.js.org/api/examples/) for guides on how to use the API. +Looking for tutorials to get started? Look at [examples](https://polkadot.js.org/api/examples/promise/) for guides on how to use the API. diff --git a/packages/type-extrinsics/README.md b/packages/type-extrinsics/README.md index 58f2e89191..b488951a56 100644 --- a/packages/type-extrinsics/README.md +++ b/packages/type-extrinsics/README.md @@ -1 +1,3 @@ # @polkadot/extrinsics + +Base extrinsic definitions & codecs \ No newline at end of file