summary refs log tree commit diff stats
path: root/README.org
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2020-04-08 15:41:58 +0530
committerAndinus <andinus@nand.sh>2020-04-08 15:43:11 +0530
commitcd94bf2bdd4da3a0e48386454916c4e7c23ae9ac (patch)
tree9d9d9f5a5dd1fe6cdd32034837a5e0f6a563f168 /README.org
parent9fc666f608fd6e156ddc3d3a5b363f341d2fb1ac (diff)
downloadgrus-048561c8ecc134de8b070cfd8c5c025ade9375e0.tar.gz
Add GRUS_PRINT_PATH variable & bump version to v0.2.1 v0.2.1
Diffstat (limited to 'README.org')
-rw-r--r--README.org14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.org b/README.org
index 909575d..7a32ef0 100644
--- a/README.org
+++ b/README.org
@@ -26,10 +26,13 @@ be changed with two environment variables documented below.
 *Note*: If grus couldn't unjumble the word with first dictionary then it'll search
 in next dictionary, search stops once the word gets unjumbled.
 
-| Environment variable | Explanation                | Non-default values |
-|----------------------+----------------------------+--------------------|
-| =GRUS_SEARCH_ALL=      | Search in all dictionaries | 1 / true           |
-| =GRUS_ANAGRAMS=        | Print all anagrams         | 1 / true           |
+| Environment variable      | Explanation                        |
+|---------------------------+------------------------------------|
+| =GRUS_SEARCH_ALL=           | Search in all dictionaries         |
+| =GRUS_ANAGRAMS=             | Print all anagrams                 |
+| =GRUS_PRINT_PATH= =(v0.2.1+)= | Print dictionary path before words |
+
+Set these environment variable to /1 / true/ to change behaviour.
 ** Default Dictionaries
 These files will be checked by default (in order).
 - =/usr/local/share/dict/words=
@@ -57,6 +60,9 @@ GRUS_SEARCH_ALL=1 grus word /path/to/dict1 /path/to/dict2
 
 # search for word in all dictionaries & print all anagrams
 GRUS_SEARCH_ALL=1 GRUS_ANAGRAMS=1 grus word
+
+# print path to dictionary
+GRUS_PRINT_PATH=1 grus word
 #+END_SRC
 * Installation
 ** Pre-built binaries