Skip to content

Update readme #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Vasilije1990 merged 2 commits into from
Dec 3, 2024
Merged

Update readme #246

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d18dd2
docs: Update README.md to have less clutter
dexters1 Dec 3, 2024
50e9b81
docs: Better wording for README.md
dexters1 Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 23 additions & 47 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Installing Cognee with PostgreSQL and Neo4j support example:
```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

```bash
poetry add cognee -E neo4j
```

### With poetry with Milvus support

Installing Cognee with PostgreSQL and Neo4j support example:
```bash
poetry add cognee -E milvus
poetry add cognee -E postgres -E neo4j
```


## 💻 Basic Usage

### Setup
Expand Down
Loading