diff --git a/README.md b/README.md index 641fcbca..e6ccf811 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,18 @@ or uv add graphiti-core ``` -You can also install optional LLM providers as extras: +### Installing with FalkorDB Support + +If you plan to use FalkorDB as your graph database backend, install with the FalkorDB extra: + +```bash +pip install graphiti-core[falkordb] + +# or with uv +uv add graphiti-core[falkordb] +``` + +### You can also install optional LLM providers as extras: ```bash # Install with Anthropic support @@ -151,6 +162,9 @@ pip install graphiti-core[google-genai] # Install with multiple providers pip install graphiti-core[anthropic,groq,google-genai] + +# Install with FalkorDB and LLM providers +pip install graphiti-core[falkordb,anthropic,google-genai] ``` ## Quick Start diff --git a/pyproject.toml b/pyproject.toml index e59448e8..67e0b17a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,7 +29,7 @@ Repository = "https://github.com/getzep/graphiti" anthropic = ["anthropic>=0.49.0"] groq = ["groq>=0.2.0"] google-genai = ["google-genai>=1.8.0"] -falkord-db = ["falkordb>=1.1.2,<2.0.0"] +falkordb = ["falkordb>=1.1.2,<2.0.0"] dev = [ "pyright>=1.1.380", "groq>=0.2.0",