Skip to content

Commit 7fd2e13

Browse files
committed
docs: standardize LlamaBot naming convention in documentation
- Correct the casing of 'LLaMaBot' to 'LlamaBot' throughout the index.md documentation - Update installation and configuration instructions for clarity - Separate API provider configuration instructions into subsections for OpenAI and Mistral This change enhances the consistency of the product name and improves the readability of the setup process for different API providers.
1 parent 2752d7e commit 7fd2e13

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

docs/index.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# LLaMaBot: A Pythonic bot interface to LLMs
1+
# LlamaBot: A Pythonic bot interface to LLMs
22

3-
LLaMaBot implements a Pythonic interface to LLMs,
3+
LlamaBot implements a Pythonic interface to LLMs,
44
making it much easier to experiment with LLMs in a Jupyter notebook
55
and build Python apps that utilize LLMs.
6-
All models supported by [LiteLLM](https://github.com/BerriAI/litellm) are supported by LLaMaBot.
6+
All models supported by [LiteLLM](https://github.com/BerriAI/litellm) are supported by LlamaBot.
77

8-
## Install LLaMaBot
8+
## Install LlamaBot
99

10-
To install LLaMaBot:
10+
To install LlamaBot:
1111

1212
```python
1313
pip install llamabot
@@ -23,20 +23,27 @@ Then follow the instructions below.
2323

2424
### Option 2: Use an API provider
2525

26-
Obtain an OpenAI API key, then configure LlamaBot to use the API key by running:
26+
#### OpenAI
27+
28+
If you have an OpenAI API key, then configure LlamaBot to use the API key by running:
2729

2830
```bash
29-
llamabot configure api-key mistral # or openai or any other provider
31+
export OPENAI_API_KEY="sk-your1api2key3goes4here"
3032
```
3133

32-
By default, this will store your API key in `$HOME/.llamabot/.llamabotrc`.
33-
The API key will then be accessible by the environment variable `{PROVIDER_NAME_UPPERCASE}_API_KEY`.
34+
#### Mistral
35+
36+
If you have a Mistral API key, then configure LlamaBot to use the API key by running:
37+
38+
```bash
39+
export MISTRAL_API_KEY="your-api-key-goes-here"
40+
```
3441

3542
## How to use
3643

3744
### SimpleBot
3845

39-
The simplest use case of LLaMaBot
46+
The simplest use case of LlamaBot
4047
is to create a `SimpleBot` that keeps no record of chat history.
4148
This is effectively the same as a _stateless function_
4249
that you program with natural language instructions rather than code.

0 commit comments

Comments
 (0)