about summary refs log tree commit diff stats
path: root/README.org
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-01-20 16:55:04 +0530
committerAndinus <andinus@nand.sh>2021-01-20 16:55:04 +0530
commitc78971d9bffb0ce05bab658b3ef3a9ece82ca7dd (patch)
tree2342c24631712294b9fb57df31a596faf5c5e4fd /README.org
parent30649012a8b20f8414756727948a3899a4b550b2 (diff)
downloadoctans-c78971d9bffb0ce05bab658b3ef3a9ece82ca7dd.tar.gz
Document new feature (reading puzzle from file), update README
README was re-generated from README.org

New feature was documented.
Diffstat (limited to 'README.org')
-rw-r--r--README.org5
1 files changed, 3 insertions, 2 deletions
diff --git a/README.org b/README.org
index 21e5dc6..5847eb1 100644
--- a/README.org
+++ b/README.org
@@ -43,8 +43,9 @@ Octans's default dictionary file is =/usr/share/dict/words=, use =--dict=
 flag to change the dictionary. The words in dictionary must be seperated
 by a newline (=\n=) & sorted alphabetically.
 
-*** url
-The url to be passed must be in either format:
+*** path
+The path to be passed must be a *readable file* or an *url* in either
+format:
 
 - Link when you view it from your local instance:
   https://tilde.zone/web/statuses/105531207939242077