aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAargh Rai <aargh.rai+git@gmail.com>2026-06-15 11:20:06 +0530
committerAargh Rai <aargh.rai+git@gmail.com>2026-06-15 11:20:06 +0530
commit5cdea40741e25529ecc8e9debcb81b49ba192b23 (patch)
tree24f6c9b0ef30b36558cce61f6cb358f304900e1b /README.md
parentff0fd9eee241d59fcf54bfe73d2ed7a6b3b31f60 (diff)
gitignore & README & help command & everything
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
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
+```