about summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2020-08-28 00:06:55 +0530
committerAndinus <andinus@nand.sh>2020-08-28 00:06:55 +0530
commit7062a6f7fbd43910e2b08e3829687bf506a55eb1 (patch)
tree84a6040bd5119fda08ab1651cc9c8eaf76b55dc2 /README
parent0576e2027196e94b13eb8281d3d6bf0a419421bc (diff)
downloadlyra-7062a6f7fbd43910e2b08e3829687bf506a55eb1.tar.gz
Add fortunes, update README, update cpanfile
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 22 insertions, 3 deletions
diff --git a/README b/README
index 2a3ecfe..0d022e8 100644
--- a/README
+++ b/README
@@ -5,6 +5,25 @@
                                ━━━━━━━━━
 
 
-Lyra is a simple cli program to manage fortune files. I wrote this for
-my quotes file. Previously I used a simple `sh(1)' function to append
-quotes & `more(1)' to read them, Lyra will replace both.
+Lyra is a simple cli program to manage fortune files. It can read
+directly from plain-text files, creating datafiles through `strfile' is
+not required.
+
+This also means that it has less features compared to fortune(6).
+Default directory is assumed to be `$HOME/fortunes'.
+
+This program is not useful if you have `strfile' installed, just use it
+& place the datafiles in fortune directory.
+
+
+1 Usage
+═══════
+
+  You have to run `lyra mirror' once before using it, it'll mirror all
+  the fortune files in `%fortune'.
+  ┌────
+  │ lyra mst # Print a random fortune from mst fortunes.
+  │ lyra mirror # Mirror fortune files.
+  │ lyra latest # Get latest fortune files.
+  │ lyra ls # List all fortune files.
+  └────