readme: update README to reflect arg rename

The size command line arg has been renamed to bitsize.
The readme usage has been updated to reflect this.

License: MIT
Signed-off-by: John Kane <john@kanej.me>
This commit is contained in:
John Kane 2016-05-26 13:55:59 +01:00
parent 52911f58d5
commit 5aa1473749

View File

@ -1,7 +1,7 @@
# ipfs-key # ipfs-key
A tool for easily generating ipfs keypairs. When run, it will write the bytes of 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 the serialized private key to stdout. By default, a 2048 bit RSA key will be
generated. The keysize can be changed by specifying the `-size` option, and the 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 key type can be changed by specifying the `-type` option (currently only RSA is
implemented). implemented).
@ -12,5 +12,5 @@ $ go get github.com/whyrusleeping/ipfs-key
## Usage ## Usage
``` ```
$ ipfs-key -size=4096 > my.key $ ipfs-key -bitsize=4096 > my.key
``` ```