@libp2p/keychain 3.0.6 → 3.0.7-1d141331a

package/README.md

@@ -1,5 +1,3 @@
-# @libp2p/keychain <!-- omit in toc -->
-
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -7,33 +5,7 @@
 
 > Key management and cryptographically protected messages
 
-## Table of contents <!-- omit in toc -->
-
-- [Install](#install)
-  - [Browser `<script>` tag](#browser-script-tag)
-- [Features](#features)
-  - [KeyInfo](#keyinfo)
-  - [Private key storage](#private-key-storage)
-  - [Physical storage](#physical-storage)
-- [API Docs](#api-docs)
-- [License](#license)
-- [Contribution](#contribution)
-
-## Install
-
-```console
-$ npm i @libp2p/keychain
-```
-
-### Browser `<script>` tag
-
-Loading this module through a script tag will make it's exports available as `Libp2pKeychain` in the global namespace.
-
-```html
-<script src="https://unpkg.com/@libp2p/keychain/dist/index.min.js"></script>
-```
-
-## Features
+# About
 
 - Manages the lifecycle of a key
 - Keys are encrypted at rest
@@ -43,7 +15,7 @@ Loading this module through a script tag will make it's exports available as `Li
 - Enforces NIST SP 800-131A and NIST SP 800-132
 - Delays reporting errors to slow down brute force attacks
 
-### KeyInfo
+## KeyInfo
 
 The key management and naming service API all return a `KeyInfo` object.  The `id` is a universally unique identifier for the key.  The `name` is local to the key chain.
 
@@ -54,9 +26,11 @@ The key management and naming service API all return a `KeyInfo` object.  The `i
 }
 ```
 
-The **key id** is the SHA-256 [multihash](https://github.com/multiformats/multihash) of its public key. The *public key* is a [protobuf encoding](https://github.com/libp2p/js-libp2p-crypto/blob/master/src/keys/keys.proto.js) containing a type and the [DER encoding](https://en.wikipedia.org/wiki/X.690) of the PKCS [SubjectPublicKeyInfo](https://www.ietf.org/rfc/rfc3279.txt).
+The **key id** is the SHA-256 [multihash](https://github.com/multiformats/multihash) of its public key.
 
-### Private key storage
+The *public key* is a [protobuf encoding](https://github.com/libp2p/js-libp2p-crypto/blob/master/src/keys/keys.proto.js) containing a type and the [DER encoding](https://en.wikipedia.org/wiki/X.690) of the PKCS [SubjectPublicKeyInfo](https://www.ietf.org/rfc/rfc3279.txt).
+
+## Private key storage
 
 A private key is stored as an encrypted PKCS 8 structure in the PEM format. It is protected by a key generated from the key chain's *passPhrase* using **PBKDF2**.
 
@@ -64,7 +38,7 @@ The default options for generating the derived encryption key are in the `dek` o
 
 ```js
 const defaultOptions = {
-  //See https://cryptosense.com/parameter-choice-for-pbkdf2/
+// See https://cryptosense.com/parameter-choice-for-pbkdf2/
   dek: {
     keyLength: 512 / 8,
     iterationCount: 1000,
@@ -76,9 +50,25 @@ const defaultOptions = {
 
 ![key storage](./doc/private-key.png?raw=true)
 
-### Physical storage
+## Physical storage
+
+The actual physical storage of an encrypted key is left to implementations of [interface-datastore](https://github.com/ipfs/interface-datastore/).
+
+A key benefit is that now the key chain can be used in browser with the [js-datastore-level](https://github.com/ipfs/js-datastore-level) implementation.
+
+# Install
+
+```console
+$ npm i @libp2p/keychain
+```
+
+## Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pKeychain` in the global namespace.
 
-The actual physical storage of an encrypted key is left to implementations of [interface-datastore](https://github.com/ipfs/interface-datastore/).  A key benefit is that now the key chain can be used in browser with the [js-datastore-level](https://github.com/ipfs/js-datastore-level) implementation.
+```html
+<script src="https://unpkg.com/@libp2p/keychain/dist/index.min.js"></script>
+```
 
 ## API Docs