README.md in pwm-1.2.0 vs README.md in pwm-1.2.1
- old
+ new
@@ -11,23 +11,37 @@
Starting with version 1.1.0, passwords are guaranteed to contain at
least one upper-case letter, one lower-case letter, and one number.
## Usage
- require 'pwm'
- Pwm.password(length)
+```ruby
+require 'pwm'
+Pwm.password(length)
+```
The default length is 16. The minimum length is 8. Specifying a length
less than 8 will raise `Pwm::TooShortException`.
You can also call pwm from the command line:
- $ pwm # default 16 character password
- $ pwm 12 # some other length
+```bash
+$ pwm
+h6ECtbDZPnRddHV7
+$ echo $?
+0
+$ pwm 8
+XdWod8f8
+$ echo $?
+0
+$ pwm 4
+length must be >= 8
+$ echo $?
+1
+```
## Author
-Mark Cornick <mark@markcornick.com>
+Mark Cornick <mark@cornick.io>
## (Lack of) Copyright
To the extent possible under law, Mark Cornick has waived all copyright
and related or neighboring rights to pwm.