Skip to content

Commit 2e212bb

Browse files
authored
Update README.md
1 parent d2b2819 commit 2e212bb

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55

66
> Ingest, Embed, and Search Text Semantically using OpenAI Embeddings + Qdrant Vector DB.
77
8-
---
8+
99

1010
## 📦 Project Overview
1111
This API enables ingestion of text data, which is embedded via OpenAI's `text-embedding-3-small` model and stored in Qdrant for semantic search.
1212

13-
---
13+
1414

1515
## 🚀 Features
1616
- Token-based auth
@@ -20,26 +20,28 @@ This API enables ingestion of text data, which is embedded via OpenAI's `text-em
2020
- Automated test suite (pytest)
2121
- Makefile for dev workflow
2222

23-
---
23+
2424

2525
## ⚙️ Requirements
2626
- Docker + Docker Compose
2727
- OpenAI API Key
2828
- Python 3.10+ (for local dev)
2929

30-
---
30+
31+
3132

3233
## 🏁 Getting Started
3334

3435
See the [full Deployment Instructions](./docs/DEPLOYMENT.md) for detailed setup and configuration steps.
3536

36-
---
3737

38-
---
38+
39+
40+
41+
3942

4043
## 📁 Project Structure
4144

42-
---
4345

4446
![System Architecture - Dark Theme](docs/system_architecture.png)
4547

@@ -72,7 +74,7 @@ second-brain/
7274
├── LICENSE
7375
└── README.md
7476
```
75-
---
77+
7678

7779
## 🔧 Setup
7880

@@ -103,15 +105,14 @@ API Docs:
103105
Qdrant Dashboard:
104106
[http://localhost:6333/dashboard](http://localhost:6333/dashboard)
105107

106-
---
107108

108109
## ✅ API Endpoints
109110

110111
- `GET /health` - Health check
111112
- `POST /ingest` - Ingest a text payload
112113
- `GET /search?q=text` - Search semantically
113114

114-
---
115+
115116

116117
## 🧪 Testing
117118
```bash
@@ -123,12 +124,12 @@ make test
123124
make lint
124125
```
125126

126-
---
127+
127128

128129
## 🛡️ License
129130
AGPLv3 — Free for use with source-sharing required for derivatives.
130131

131-
---
132+
132133

133134
## 🛠️ Roadmap
134135
- API Rate Limiting

0 commit comments

Comments
 (0)