From f7ee2172dadf0bd50cacccf506cfe26c607e26c7 Mon Sep 17 00:00:00 2001
From: Senghan Bright <senghan.bright@deltaprojects.com>
Date: Wed, 4 Aug 2021 10:58:51 +0200
Subject: [PATCH] docs: update read me with `db_root` information.

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index d0d3491..443d2a2 100644
--- a/README.md
+++ b/README.md
@@ -123,6 +123,7 @@ Determines if non-indexed files are included in workspace filter results.
 telescope.setup {
   extensions = {
     frecency = {
+      db_root = "home/my_username/path/to/db_root"
       show_scores = false,
       show_unindexed = true,
       ignore_patterns = {"*.git/*", "*/tmp/*"},
@@ -137,6 +138,11 @@ telescope.setup {
 }
 ```
 
+### SQL database location
+
+The default location for the sqlite3 database is `$XDG_DATA_HOME/nvim` (eg `~/.local/share/nvim/` on linux).
+This can be configured with the `db_root` config option.
+
 ### SQL database maintainance
 
 By default, frecency will prune files that no longer exist from the database.