From 49170617b9bda3b1d7c097c7768749e5670972b7 Mon Sep 17 00:00:00 2001 From: Shantanu Date: Sun, 22 Dec 2024 13:16:00 +0530 Subject: [PATCH] docs: Update README to add embed usage instructions --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 932be3f..66d5849 100644 --- a/README.md +++ b/README.md @@ -20,24 +20,22 @@ ## Usage -To start a conversation with a document, simply run: +To start a conversation with a document (`.pdf` and `.docx` for now), simply run: ```bash lesa read path/to/your/document ``` -`lesa` supports PDF and DOCX files at the moment. +### Embed -### Example +To embed all files from your current working directory, run: -```console -foo@bar:~$ lesa read documents/Microprocessor.pdf - -> You: what is the difference between real mode and protected mode? - -> Lesa: According to the system's context, there are three differentiating points between real mode and protected mode... +```bash +lesa embed ``` +This creates a `.lesa` config folder in your current working directory that stores the embeddings of all the documents in the directory. +