Docs update, getting started (#219)

* Docs update, getting started

* Typos

* Cleanups, linking

* Update with additional packages
This commit is contained in:
Jaco Greeff
2019-10-16 12:35:34 +02:00
committed by GitHub
parent b1c1f108e7
commit c58835059d
12 changed files with 367 additions and 11 deletions
+3 -2
View File
@@ -7,7 +7,7 @@
# @polkadot/ui
Basic browser and UI components for creating apps using the polkadot{.js} libraries
Basic browser and framework agnostic UI components for creating apps using the polkadot{.js} libraries
## overview
@@ -18,7 +18,7 @@ The following UI components are currently available -
- [vue-identicon](packages/vue-identicon/) Vue identity icon generator with address as input
- [react-qr](packages/react-qr/) QR code generator/reader for [uos](https://github.com/maciejhirsz/uos) (Substrate/Polkadot only)
Additionally some shared libraries -
Additionally some shared libraries, that is not dependent on any framework -
- [ui-assets](packages/ui-assets/) Static assets, images and others, shared accross projects
- [ui-keyring](packages/ui-keyring/) A browser-specific wrapper around the base [@polkadot/util-keyring](https://github.com/polkadot-js/util/) library
@@ -30,4 +30,5 @@ Additionally some shared libraries -
In addition to the above packages, there are examples available for intergation of `ui-keyring`, `ui-settings` & the relevant `*-identicon` package. These are
- [example-react](packages/example-react) - start with `yarn example:react` and view on `http://localhost:8080`
- [example-reactnative](packages/exampleReactNative) - start with `yarn example:rn:packager` to start the packager service and then either `yarn example:rn:android` or `yarn example:rn:ios` in another terminal
- [example-vue](packages/example-vue) - start with `yarn example:vue` and view on `http://localhost:8080`