52 lines
2.0 KiB
Markdown
52 lines
2.0 KiB
Markdown
---
|
|
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
|
|
- [util](util/README.md) General utilities
|
|
- [util-crypto](util-crypto/README.md) Crypto and hashing utilities
|
|
|
|
## The Polkadot Project
|
|
|
|
You can read more about the Polkadot Network at [https://polkadot.network/](https://polkadot.network/)
|
|
|
|
## Github repositories
|
|
|
|
You can find the Polkadot repositories at:
|
|
|
|
- [https://github.com/polkadot-js](https://github.com/polkadot-js)
|
|
- [https://github.com/paritytech/polkadot](https://github.com/paritytech/polkadot)
|
|
- [https://github.com/paritytech/substrate](https://github.com/paritytech/substrate)
|
|
|
|
This documentation is generated from [https://github.com/polkadot-js/common](https://github.com/polkadot-js/common)
|
|
|
|
## Contributing
|
|
|
|
Contribution to Polkadot JS Common are more than welcome. You can [report issues](https://github.com/polkadot-js/common/issues/new) and [log feature requests](https://github.com/polkadot-js/common/issues/new).
|