docs: Fixes #275. Update Readme package names and links (#286)

* docs: Fixes #275. Update Readme package names and links

* Update README.md
This commit is contained in:
Luke Schoen
2018-10-14 09:32:51 +02:00
committed by Jaco Greeff
parent 06be0b09c7
commit 3e20e7b10d
2 changed files with 8 additions and 5 deletions
+6 -5
View File
@@ -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 - The API is split up into a number of internal packages -
- [@polkadot/api](packages/api/) The low-level base API library - [@polkadot/api](packages/api/) The API library, providing both Promise and RxJS Observable-based interfaces
- [@polkadot/api-codec](packages/api-codec/) Codecs for all Polkadot primitives - [@polkadot/api-observable](packages/api-observable/) A combination Observable wrapper around [@polkadot/api/rx](packages/api/rs)
- [@polkadot/api-rx](packages/api-rx/) A RxJs Observable wrapper around the API - [@polkadot/rpc-core](packages/rpc-core/) Wrapper around all methods exposed by a Polkadot network client
- [@polkadot/api-provider](packages/api-provider/) Providers for connecting - [@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 - Type definitions for interfaces as exposed by Polkadot & Substrate clients -
- [@polkadot/extrinsics](packages/type-extrinsics/) Base extrinsic definitions & codecs - [@polkadot/extrinsics](packages/type-extrinsics/) Base extrinsic definitions & codecs
- [@polkadot/jsonrpc](packages/type-jsonrpc/) Definitions for JSONRPC endpoints - [@polkadot/jsonrpc](packages/type-jsonrpc/) Definitions for JSONRPC endpoints
- [@polkadot/storage](packages/type-storage/) Definitions for storage entries - [@polkadot/storage](packages/type-storage/) Definitions for storage entries
- [@polkadot/types](packages/types/) Codecs for all Polkadot primitives
## development ## development
@@ -46,4 +47,4 @@ To get started -
## tutorials ## 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.
+2
View File
@@ -1 +1,3 @@
# @polkadot/extrinsics # @polkadot/extrinsics
Base extrinsic definitions & codecs