Fixing the README.md based on review comments
This commit is contained in:
parent
d7404b100f
commit
ceb6bf1326
35
README.md
35
README.md
|
@ -1,16 +1,39 @@
|
||||||
# ipfs-key
|
# ipfs-key
|
||||||
A tool for easily generating ipfs keypairs. When run, it will write the bytes of
|
|
||||||
the serialized private key to stdout. By default, a 2048 bit RSA key will be
|
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
|
||||||
generated. The keysize can be changed by specifying the `-bitsize` option, and the
|
|
||||||
key type can be changed by specifying the `-type` option (currently only RSA is
|
> A tool for easily generating ipfs keypairs
|
||||||
implemented).
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [Contribute](#contribute)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```
|
```
|
||||||
$ go get github.com/whyrusleeping/ipfs-key
|
$ go get github.com/whyrusleeping/ipfs-key
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
When run, it will write the bytes of
|
||||||
|
the serialized private key to stdout. By default, a 2048 bit RSA key will be
|
||||||
|
generated. In this case the key size can be changed by specifying the `-bitsize`
|
||||||
|
option. The key type can be changed by specifying the `-type` option (rsa or
|
||||||
|
ed25519). Currently only the RSA uses the -bitsize option.
|
||||||
|
|
||||||
```
|
```
|
||||||
$ ipfs-key -bitsize=4096 > my.key
|
$ ipfs-key -bitsize=4096 > my-rsa4096.key
|
||||||
|
$ ipfs-key -type=ed25519 > my-ed.key
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Contribute
|
||||||
|
|
||||||
|
PRs accepted.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT](LICENSE) Copyright (c) 2016 [Jeromy Johnson](http://github.com/whyrusleeping)
|
Loading…
Reference in New Issue
Block a user