diff --git a/README.md b/README.md index 4347b3c4..8c45ed4f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ -### OpenRAG +## OpenRAG [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/phact/openrag) +### getting started + +Set up your secrets: + + cp .env.example .env + +Populate the values in .env + +Requirements: + +Docker or podman with compose installed. + +Run OpenRAG: + docker compose build docker compose up @@ -9,3 +23,7 @@ CPU only: docker compose -f docker-compose-cpu.yml up + +If you need to reset state: + + docker compose up --build --force-recreate --remove-orphans