Skip to content

Commit

Permalink
docs: Update README to add embed usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
shxntanu committed Dec 22, 2024
1 parent a966bb8 commit 4917061
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- ## Features
- 🖥️ **Completely On-Device**: Uses Ollama under the hood to interface with LLMs, so you can be sure your data is not leaving your device.
Expand Down

0 comments on commit 4917061

Please sign in to comment.