[elpa] externals/elisa f3d21b65d4 04/98: Fill readme with simple use case

[ELPA Syncer]

branch: externals/elisa
commit f3d21b65d46d8335edaf9b19b1b23e19d8bba794
Author: Sergey Kostyaev <kostyaev.sergey2@wb.ru>
Commit: Sergey Kostyaev <kostyaev.sergey2@wb.ru>

    Fill readme with simple use case
---
 README.org | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

diff --git a/README.org b/README.org
index 3c7ca6de67..861d787d5a 100644
--- a/README.org
+++ b/README.org
@@ -16,8 +16,49 @@ for both beginners and advanced Emacs users.
 
 ** Commands
 
+*** elisa-chat
+
+Entrypoint. Makes similarity search in index, add semantically similar
+info nodes into context and query llm for prompt. Uses ~ellama~ under
+the hood. Call one of parse manuals functions to create index before
+use it.
+
+*** elisa-download-sqlite-vss
+
+Download [[https://github.com/asg017/sqlite-vss][sqlite vss]] extension to 
provide similarity search. Will be
+called automatically if needed.
+
+*** elisa-async-parse-builtin-manuals
+
+Parse builtin emacs info manuals asyncronously. Can take long time.
+
+*** elisa-async-parse-external-manuals
+
+Parse external emacs info manuals asyncronously.
+
+*** elisa-async-parse-all-manuals
+
+Parse all emacs info manuals asyncronously.
+
+One of parse functions should be called before ~elisa-chat~ to create
+index.
+
 ** Configuration
 
+Example configuration. I use 
[[https://github.com/toshsan/embedding-server][toshsan/embedding-server]] for 
embeddings.
+
+#+begin_src emacs-lisp
+  (use-package elisa
+  :init
+  (setopt elisa-embeddings-provider (progn
+                                     (require 'llm-openai)
+                                     (setq llm-warn-on-nonfree nil)
+                                     (make-llm-openai-compatible
+                                      :embedding-model "all-MiniLM-L6-v2"
+                                      :url "http://localhost:8000/v1";
+                                      :key "YOUR_KEY"))))
+#+end_src
+
 ** Contributions
 
 To contribute, submit a pull request or report a bug. This library is