cascade/docker-ipfs-keygen
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixing the README.md based on review comments

Browse Source
This commit is contained in:
Wigy 2016-12-20 12:52:00 +01:00
parent d7404b100f
commit ceb6bf1326
No known key found for this signature in database
GPG Key ID: AFF11C67C4E13357
1 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,16 +1,39 @@
# 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
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
implemented).
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
> A tool for easily generating ipfs keypairs
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)
## Installation
```
$ go get github.com/whyrusleeping/ipfs-key
```
## 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)