[elpa] externals/ellama 39b0a6cc92 10/11: Update documentation

[ELPA Syncer]

branch: externals/ellama
commit 39b0a6cc928357476bb02e639551602818ed6ad1
Author: Sergey Kostyaev <sskostyaev@gmail.com>
Commit: Sergey Kostyaev <sskostyaev@gmail.com>

    Update documentation
---
 NEWS.org  |  2 ++
 README.md | 22 +++++++++++++++++++---
 ellama.el | 11 ++++++++---
 3 files changed, 29 insertions(+), 6 deletions(-)

diff --git a/NEWS.org b/NEWS.org
index 83db750b86..daf9779a18 100644
--- a/NEWS.org
+++ b/NEWS.org
@@ -1,3 +1,5 @@
+* Version 0.6.0
+- Implement session management.
 * Version 0.5.8
 - Fix typo in predefined prompts.
 * Version 0.5.7
diff --git a/README.md b/README.md
index cbfe40142e..fee1feafeb 100644
--- a/README.md
+++ b/README.md
@@ -151,6 +151,22 @@ simple using Ellama.
 Render the currently selected text or the text in the current buffer
 as a specified format using Ellama.
 
+### ellama-load-session
+
+Load ellama session from file.
+
+### ellama-session-remove
+
+Remove ellama session.
+
+### ellama-session-switch
+
+Change current active session.
+
+### ellama-session-rename
+
+Rename current ellama session.
+
 ## Keymap
 
 Here is a table of keybindings and their associated functions in
@@ -184,13 +200,10 @@ Ellama, using the `C-c e` prefix:
 
 The following variables can be customized for the Ellama client:
 
-- `ellama-buffer`: The default Ellama buffer name.
 - `ellama-enable-keymap`: Enable the Ellama keymap.
 - `ellama-keymap-prefix`: The keymap prefix for Ellama.
 - `ellama-user-nick`: The user nick in logs.
 - `ellama-assistant-nick`: The assistant nick in logs.
-- `ellama-buffer-mode`: The major mode for the Ellama logs buffer.
-Default mode is `markdown-mode`.
 - `ellama-language`: The language for Ollama translation. Default
 language is english.
 - `ellama-provider`: llm provider for ellama. Default provider is
@@ -214,6 +227,9 @@ documentation](https://elpa.gnu.org/packages/llm.html)
 chat response generation done. It should be a function with single
 argument generated text string.
 - `ellama-nick-prefix`: User and assistant nick prefix in logs.
+- `ellama-session-file-extension`: File extension for saving ellama
+  session. Default value "md".
+- `ellama-sessions-directory`: Directory for saved ellama sessions.
 
 ## Acknowledgments
 
diff --git a/ellama.el b/ellama.el
index a23e48b7b2..b4b284a789 100644
--- a/ellama.el
+++ b/ellama.el
@@ -6,7 +6,7 @@
 ;; URL: http://github.com/s-kostyaev/ellama
 ;; Keywords: help local tools
 ;; Package-Requires: ((emacs "28.1") (llm "0.6.0") (spinner "1.7.4"))
-;; Version: 0.5.8
+;; Version: 0.6.0
 ;; SPDX-License-Identifier: GPL-3.0-or-later
 ;; Created: 8th Oct 2023
 
@@ -394,6 +394,7 @@ PROMPT is a variable contains last prompt in this session."
 
 (advice-add #'save-buffer :before #'ellama--save-session)
 
+;;;###autoload
 (defun ellama-load-session ()
   "Load ellama session from file."
   (interactive)
@@ -422,6 +423,7 @@ PROMPT is a variable contains last prompt in this session."
     (kill-buffer session-buffer)
     (display-buffer buffer)))
 
+;;;###autoload
 (defun ellama-session-remove ()
   "Remove ellama session."
   (interactive)
@@ -437,6 +439,7 @@ PROMPT is a variable contains last prompt in this session."
     (delete-file file t)
     (delete-file session-file t)))
 
+;;;###autoload
 (defun ellama-session-switch ()
   "Change current active session."
   (interactive)
@@ -447,6 +450,7 @@ PROMPT is a variable contains last prompt in this session."
     (setq ellama--current-session-id id)
     (display-buffer buffer)))
 
+;;;###autoload
 (defun ellama-session-rename ()
   "Rename current ellama session."
   (interactive)
@@ -484,6 +488,8 @@ PROMPT is a variable contains last prompt in this session."
   "Query ellama for PROMPT.
 ARGS contains keys for fine control.
 
+:provider PROVIDER -- PROVIDER is an llm provider for generation.
+
 :buffer BUFFER -- BUFFER is the buffer (or `buffer-name') to insert ellama 
reply
 in.  Default value is (current-buffer).
 
@@ -492,8 +498,7 @@ in.  Default value is (current-buffer).
 :filter FILTER -- FILTER is a function that's applied to (partial) response
 strings before they're inserted into the BUFFER.
 
-:session SESSION -- if session is non-nil, the PROMPT will be appended to the
-current (BUFFER-local) conversation.
+:session SESSION -- SESSION is a ellama conversation session.
 
 :on-error ON-ERROR -- ON-ERROR a function that's called with an error message 
on
 failure (with BUFFER current).