From de0e6fcde0f4fdd9a08255dac52629bec28a0ca3 Mon Sep 17 00:00:00 2001
From: lukeflo
Date: Mon, 17 Feb 2025 21:43:18 +0100
Subject: Update README

---
 README.md | 39 ++++++++++++++++++++++++++++++++++-----
 1 file changed, 34 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8285e37..deb65d8 100644
--- a/README.md
+++ b/README.md
@@ -95,6 +95,35 @@ Here is how the light terminal scheme looks:
 
 ![bibiman-light-theme.png](https://codeberg.org/attachments/7fe9d58d-7e90-4043-9402-5e4664c4e22a)
 
+## Configuration
+
+### Location of Config File
+
+`bibiman` can be configured through a config file. The standard location is the user's config dir following the XDG scheme. On Linux systems this defaults to:
+
+```bash
+# XDG scheme:
+$XDG_CONFIG_HOME/bibiman/bibiman.toml
+
+# Fallback:
+$HOME/.config/bibiman/bibiman.toml
+
+```
+
+### Values
+
+At the moment, the following values can be set through the config file:
+
+```toml
+[general]
+# Default files/dirs which are loaded on startup
+bibfiles = [ "/path/to/bibfile", "path/to/dir/with/bibfiles" ]
+# Default editor to use when editing files. Arguments are possible
+editor = "vim" # with args: "vim -y"
+```
+
+Paths to bibfiles/dirs passed through the CLI will be added to the ones provided by the config file.
+
 ## Features
 
 These are the current features, the list will be updated:
@@ -113,9 +142,9 @@ These are the current features, the list will be updated:
       position in bibfile.
 - [x] **Load multiple files** into one session.
 - [x] **Add Entry via DOI**.
-- [ ] **Open related notes file** for specific entry.
-- [ ] **Implement config file** for setting some default values like main
+- [x] **Implement config file** for setting some default values like main
       bibfile, PDF-opener, or editor
+- [ ] **Open related notes file** for specific entry.
 - [ ] **Support Hayagriva(`.yaml`)** format as input (_on hold for now_, because
       the Hayagriva Yaml style doesn't offer keywords; s. issue in
       [Hayagriva repo](https://github.com/typst/hayagriva/issues/240)).
@@ -158,10 +187,10 @@ enabled by default. You can use some special chars to alter pattern matching:
 
 ## Edit bib entry
 
-For now, the TUI only supports editors set through the environment variables
-`VISUAL` and `EDITOR` in this order. The fallback solution is `vi`.
+The main editor can be set through the [config file](#values). Otherwise, the environment variables
+`VISUAL` and `EDITOR` will be used in this order. The last fallback solution is `vi`.
 
-I've tested the following editors (set as value of `VISUAL`):
+I've tested the following editors (set as value of `VISUAL` and through the config file):
 
 - [x] **Helix**: `export VISUAL="hx"`
 - [x] **Vim/Neovim**: `export VISUAL="vim/nvim"`
-- 
cgit v1.2.3