Align docs with main site (and link to others) (#343)

* Align docs with main site (and link to others) * Add project family link
2019-03-01 12:09:39 +01:00
parent d7854a2081
commit 179aa8498c
3 changed files with 46 additions and 3 deletions
@@ -1,7 +1,31 @@
-# Polkadot Javascript Common
+---
+home: true
+heroText:
+tagline:
+# Bringing JavaScript to the Polkadot world.
+# actionText: Repository Overview
+# actionLink: /REPOS.md
+features:
+- title: Keyring
+  details: Manage user keys allowing for signing, encryption and decryption.
+- title: Utilities
+  details: Various user utilities to work with data and perform check on it.
+- title: Crypto
+  details: A thin and easy-to-use wrapper around cryptographic and hashing libraries.
+
+footer: Apache-2 Licensed | Copyright © 2017-2019 polkadot-js authors and contributors
+---
+
+## Welcome

 Various useful utility functions that are used across all projects in the [@polkadot](https://polkadot.js.org) namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

+::: tip Examples
+In a rush and just want examples? [Jump right in](/examples/keyring/) and get a handle on using the various components in your projects.
+:::
+
+## Available packages
+
 It is split up into a number of internal packages, namely utilities -

 - [keyring](keyring/README.md) Keyring management