commit 4b37d3b88d3c3a2b14fe770546a7ff6797322264
parent c19ba6bb9575386b1c359be2692e3c0db60b9c82
Author: Stephen Gregoratto <dev@sgregoratto.me>
Date: Wed, 12 Feb 2020 00:42:03 +1100
Simplify readme and remove redundant sections
Diffstat:
| M | README.md | | | 56 | +------------------------------------------------------- |
1 file changed, 1 insertion(+), 55 deletions(-)
diff --git a/README.md b/README.md
@@ -10,37 +10,8 @@ Features:
## Requirements
-Build requirements:
* C89 compiler
-
-Run-time requirements:
* POSIX-compliant system
-* support for [arc4random_uniform(3)] (i.e. OpenBSD, FreeBSD, macOS)
-
-## Install on OpenBSD
-```sh
-$ make
-$ doas make install
-```
-
-## Install on macOS
-```sh
-$ make
-$ sudo make install
-```
-
-## Examples
-Random password from a 40 bit key space:
-```sh
-$ rpass
-jikmus xuzjex
-```
-
-Random password from a 60 bit key space:
-```sh
-$ rpass 60
-loltuk zahxok takrep
-```
## Key space requirements
@@ -50,33 +21,8 @@ The default key space of 40 bits relies on the following requirements:
* the password is stored using [bcrypt(3)] with 2^10 rounds
* the password only has to be secure for one year
-Additional details about this calculation can be found in the [manual].
-
-## Documentation
-
-All features are documented in the manual: [rpass(1)].
-
-## License
-
-ISC
-
-Copyright (c) 2017, 2019 Tim Kuijsten
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
+Additional details about this calculation can be found in the manpage.
[8x Nvidia GTX 1080 Ti Hashcat Benchmarks]: https://gist.github.com/epixoip/ace60d09981be09544fdd35005051505
[arc4random_uniform(3)]: https://man.openbsd.org/arc4random_uniform.3
[bcrypt(3)]: https://man.openbsd.org/bcrypt.3
-[rpass(1)]: https://netsend.nl/rpass/rpass.1.html
-[manual]: https://netsend.nl/rpass/rpass.1.html