diff --git a/README.md b/README.md index 397c0f0..874fc10 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # excitation The CLI tool to generate IP addresses for documentation as defined by RFC5737 + +## Example + +```sh +$ ./excitation --help +The CLI tool to generate IP addresses for documentation as defined by RFC5737 + +Usage: excitation [OPTIONS] + +Options: + -n, --number Number of generate addresses [default: 1] + -b, --block Network block [default: 1] + -h, --help Print help + -V, --version Print version + +$ ./excitation -b 3 -n 4 +203.0.113.60 +203.0.113.15 +203.0.113.187 +203.0.113.100 +```