From 14994e26df072a6d154c053d7c8c3c80273a4d7b Mon Sep 17 00:00:00 2001
From: "Jakob L. Kreuze" <zerodaysfordays@sdf.org>
Date: Fri, 19 Jun 2020 18:54:38 -0400
Subject: Change how birka-cli finds the tag database.

There are now two options for specifying a path, in order of precedence:
* `-o`, or `--output` command-line arguments.
* The `TB_PATH` environment variable.
---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 99299ef..0ece336 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,13 @@ $ birka-cli query
 ...
 ```
 
+The tag database is stored in a file, and the path of that file is dependent on
+how the program is invoked. If, when parsing the command-line arguments,
+`birka-cli` sees a `-o` or `--output` argument, the path following that argument
+will be used. Alternatively, the `TB_PATH` environment variable can be
+specified, but `-o` takes a higher precedence. If neither are specified,
+"birka.db" in the current directory is used.
+
 ### Web-Interface (API)
 
 The web interface for бирка-тян exposes a RESTful API for remotely interacting
-- 
cgit v1.3