gmakstutis/cognee
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update README.md to have less clutter

Browse source 
Resolve clutter in README.md

docs
This commit is contained in:
Igor Ilic 2024-12-03 17:33:18 +01:00
parent bd0227b551
commit 1d18dd2f18
1 changed files with 23 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -20,7 +20,7 @@ If you have questions, join our <a href="https://discord.gg/NQPKmU5CCg">Discord
## 📦 Installation
You can install Cognee using either **pip** or **poetry**.
You can install Cognee using either **pip** or **poetry**.
Support for various databases and vector stores is available through extras.
### With pip
@ -29,73 +29,49 @@ Support for various databases and vector stores is available through extras.
pip install cognee
```
### With pip with PostgreSQL support
```bash
pip install 'cognee[postgres]'
```
### With pip with Weaviate support
```bash
pip install 'cognee[weaviate]'
```
### With pip with Qdrant support
```bash
pip install 'cognee[qdrant]'
```
### With pip with Neo4j support
```bash
pip install 'cognee[neo4j]'
```
### With pip with Milvus support
```bash
pip install 'cognee[milvus]'
```
### With poetry
```bash
poetry add cognee
```
### With poetry with PostgreSQL support
### With pip with specific database support
To install Cognee with support for specific databases use the appropriate command below. Replace \<database> with the name of the database you need.
```bash
poetry add cognee -E postgres
pip install 'cognee[<database>]'
```
### With poetry with Weaviate support
Replace \<database> with any of the following databases:
- postgres
- weaviate
- qdrant
- neo4j
- milvus
For example with postgres and neo4j support:
```bash
poetry add cognee -E weaviate
pip install 'cognee[postgres, neo4j]'
```
### With poetry with Qdrant support
### With poetry with specific database support
To install Cognee with support for specific databases use the appropriate command below. Replace \<database> with the name of the database you need.
```bash
poetry add cognee -E qdrant
poetry add cognee -E <database>
```
Replace \<database> with any of the following databases:
- postgres
- weaviate
- qdrant
- neo4j
- milvus
### With poetry with Neo4j support
For example with postgres and neo4j support:
```bash
poetry add cognee -E neo4j
poetry add cognee -E postgres -E neo4j
```
### With poetry with Milvus support
```bash
poetry add cognee -E milvus
```
## 💻 Basic Usage
### Setup