From 043f66b767ff7325461f869d34e0c173095c0dd9 Mon Sep 17 00:00:00 2001 From: ItzCrazyKns Date: Wed, 17 Apr 2024 19:42:08 +0530 Subject: [PATCH] feat(readme): Update installation steps --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 227e7c9..ac0fcfe 100644 --- a/README.md +++ b/README.md @@ -51,14 +51,15 @@ There are mainly 2 ways of installing Perplexica - With Docker, Without Docker. 2. Clone the Perplexica repository: ```bash - git clone https://github.com/ItzCrazyKns/Perplexica.git + git clone -b feat/ollama-support https://github.com/ItzCrazyKns/Perplexica.git ``` 3. After cloning, navigate to the directory containing the project files. 4. Rename the `.env.example` file to `.env`. For Docker setups, you need only fill in the following fields: - - `OPENAI_API_KEY` + - `OLLAMA_URL` (It should be the URL where Ollama is running; it is also filled by default but you need to replace it if your Ollama URL is different.) + - `MODEL_NAME` (This is filled by default; you can change it if you want to use a different model.) - `SIMILARITY_MEASURE` (This is filled by default; you can leave it as is if you are unsure about it.) 5. Ensure you are in the directory containing the `docker-compose.yaml` file and execute: