Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kadoshita committed Jun 25, 2023
1 parent 0e6d138 commit 2cb2ac7
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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> Number of generate addresses [default: 1]
-b, --block <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
```

0 comments on commit 2cb2ac7

Please sign in to comment.