diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..56a5e7c --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Lorem + +Generate lorem ipsum + +``` +usage: lorem [OPTIONS] + +positional arguments: + mode generation mode: [w]ord, [l]ine/[s]entence, [p]aragraph (default: line) + length number of chunks to generate (default: 1) + +options: + -h --help show this message + +examples: + lorem p 2 generate 2 paragraphs + lorem w 2 generate 2 words + lorem l 2 generate 2 lines/sentences + lorem s 2 generate 2 lines/sentences + lorem 2 generate 2 lines/sentences + lorem generate 1 line/sentence + lorem paragraph 2 generate 2 paragraphs + lorem word 2 generate 2 words + lorem line 2 generate 2 lines/sentences + lorem sentence 2 generate 2 lines/sentences +``` |