~mcornick/linenoise

71c7fbe3198abd689b04ea9824ec305fa38f2403 — Mark Cornick a month ago cc50a8c
docs: minor README fixes
1 files changed, 2 insertions(+), 3 deletions(-)

M README.md
M README.md => README.md +2 -3
@@ 2,7 2,7 @@

linenoise is a library that generates strings of random characters
(herein called a "noise") that can be used as reasonably secure
passwords.It is an extraction of the password generator from my prior
passwords. It is an extraction of the password generator from my prior
project [genpw](https://github.com/markcornick/genpw), and intended to
be genpw's successor.



@@ 14,8 14,7 @@ linenoise exports one function and one struct.
`Parameters` (see next paragraph.) It returns a `string` and an `error`.
If the `Parameters` can be used to create a noise with the desired
length, the `string` is the generated noise and the `error` is `nil`.
Otherwise, the `string` is `""` and the `error` is a typical Go error
object.
Otherwise, the `string` is `""` and the `error` is a typical Go error.

`Parameters` is a struct containing the following: