From 3a40bbb367a79dc3660c12aa7f62e3efc378ea22 Mon Sep 17 00:00:00 2001
From: lukeflo
Date: Mon, 30 Jun 2025 16:33:01 +0200
Subject: update README: note feature

---
 README.md | 33 +++++++++++++++++++++++++--------
 1 file changed, 25 insertions(+), 8 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 5bc40b3..4f0e505 100644
--- a/README.md
+++ b/README.md
@@ -213,6 +213,16 @@ file_prefix = "/some/path/prefix"
 # of the format "citekey.pdf". Other PDF basenames are not accepted.
 # Use absolute paths (~ for HOME works). Otherwise, loading might not work.
 pdf_path = "/path/to/pdf-folder"
+## Path to folder (with subfolders) containing note files with the basename of
+## the format "citekey.extension". Other basenames are not accepted. The possible
+## extensions can be set through the "note_extensions" array.
+note_path = "path/to/note-files"
+note_extensions = [ "md", "txt" ]
+
+## Symbols/chars to show if not has specific attachement
+ file_symbol = " "
+ link_symbol = "󰌹 "
+ note_symbol = "󰧮"
 ```
 
 `bibfiles`
@@ -246,13 +256,14 @@ pdf_path = "/path/to/pdf-folder"
   created through the `pdf_path` variable. Thus, it is safe to mix both
   approaches if wanted!
 
-`pdf_path`
+`pdf_path` and `note_path`
 
-: The `pdf_path` is used as path wich is recursivley searched for files which
-  basename consists of the an entrys `citekey` plus a `.pdf` ending
-  (case-insensitive). Every file which matches this pattern for an existing
-  `citekey` is associated with the particular entry for the current `bibiman`
-  session and can be opened from within.
+: The `pdf_path`/`note_path` is used as path wich is recursivley searched for
+  files which basename consists of the an entrys `citekey` plus a `.pdf` ending
+  or one of the specified note endinfs (case-insensitive). Every file which
+  matches this pattern for an existing `citekey` is associated with the
+  particular entry for the current `bibiman` session and can be opened from
+  within.
 
 ### Color Configuration<a name="color-configuration"></a>
 
@@ -272,6 +283,12 @@ warn_color = "124"
 bar_bg_color = "234"
 popup_bg_color = "234"
 selected_row_bg_color = "237"
+note_color = "123"
+file_color = "209"
+link_color = "27"
+author_color = "38"
+title_color = "37"
+year_color = "135"
 ```
 
 Colors can be set through three different methods:
@@ -309,7 +326,7 @@ These are the current features, the list will be updated:
 - [x] **Add Entry via DOI**.
 - [x] **Implement config file** for setting some default values like main
   bibfile, PDF-opener, or editor
-- [ ] **Open related notes file** for specific entry.
+- [x] **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)).
@@ -346,7 +363,7 @@ Use the following keybindings to manage the TUI:
 There are some shortcuts to select an item from the opening/yanking popup
 without navigating the list:
 
-- `o-o`|`o-l`: directly opens the first file/link for the selected entry.
+- `o-o`|`o-l`|`o-n`: directly opens the first file|link|note for the selected entry.
 - `y-y`: directly yanks the citekey of the selected entry to the clipboard.
 
 ## Search<a name="search"></a>
-- 
cgit v1.2.3