branch: externals/ellama
commit 78582e680df2bf61685f6b371536e65f2c7797e8
Author: Sergey Kostyaev <sskosty...@gmail.com>
Commit: Sergey Kostyaev <sskosty...@gmail.com>
Add Ellama Session Header Line and Mode Line Modes documentation
---
README.org | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 50 insertions(+)
diff --git a/README.org b/README.org
index 31dfb247d0..9c9fe8a4fe 100644
--- a/README.org
+++ b/README.org
@@ -551,6 +551,56 @@ This globalized minor mode provides a convenient way to
ensure that
context-specific mode line information is always available, regardless of the
buffer being edited.
+*** Ellama Session Header Line Mode
+
+The ~ellama-session-header-line-mode~ is a minor mode that allows you to
display
+the current Ellama session ID in the header line of your Emacs buffers. This
+feature helps keep track of which session you are working with, especially
+useful when managing multiple sessions.
+
+**** Enabling and Disabling
+
+To enable this mode, use the following command:
+#+BEGIN_SRC emacs-lisp
+M-x ellama-session-header-line-mode
+#+END_SRC
+
+This will toggle the display of the session ID in the header line. You can also
+enable or disable it globally across all buffers using:
+#+BEGIN_SRC emacs-lisp
+M-x ellama-session-header-line-global-mode
+#+END_SRC
+
+**** Customization
+
+The session ID is displayed with a customizable face called ~ellama-face~. You
+can customize this face to change its appearance.
+
+*** Ellama Session Mode Line Mode
+
+The ~ellama-session-mode-line-mode~ is a minor mode that allows you to display
+the current Ellama session ID in the mode line of your Emacs buffers. This
+feature provides an additional way to keep track of which session you are
+working with, especially useful when managing multiple sessions.
+
+**** Enabling and Disabling
+
+To enable this mode, use the following command:
+#+BEGIN_SRC emacs-lisp
+M-x ellama-session-mode-line-mode
+#+END_SRC
+
+This will toggle the display of the session ID in the mode line. You can also
+enable or disable it globally across all buffers using:
+#+BEGIN_SRC emacs-lisp
+M-x ellama-session-mode-line-global-mode
+#+END_SRC
+
+**** Customization
+
+The session ID is displayed with a customizable face called ~ellama-face~. You
+can customize this face to change its appearance.
+
** Using Blueprints
Blueprints in Ellama refer to predefined templates or structures that
facilitate
