From ceb6bf1326d88aab13e2f6068fa846b13baf9380 Mon Sep 17 00:00:00 2001 From: Wigy Date: Tue, 20 Dec 2016 12:52:00 +0100 Subject: [PATCH] Fixing the README.md based on review comments --- README.md | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 23a1cc2..d3a3948 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file