Skip to content

Commit d1e0716

Browse files
Update README.md
1 parent 1e87efe commit d1e0716

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,21 @@
1010

1111
---
1212

13-
# Flint
13+
# *Flint*
1414

1515
> - A **secure, local-first knowledge base** with AI-powered intelligence. Your notes, your graph, your AI - all running locally on your machine.
1616
1717
---
1818

1919
https://github.com/user-attachments/assets/94fa53f9-b3b6-4df8-9038-3f763aec54d4
20+
> [!IMPORTANT]
2021
> - The connection lines between the nodes are very thin, so it's not visible in the video. I will fix it very soon.
22+
2123
---
2224

2325
## Installation
2426

25-
### Prerequisites
26-
- **Node.js** 18+ — [Install](https://nodejs.org)
27-
- **Python 3** (for AI Agent) — `sudo apt install python3 python3-pip`
28-
- **Ollama** (for AI) — [Install](https://ollama.ai) then `ollama pull llama3.2`
29-
30-
### Install with
27+
### For useres !!
3128
```bash
3229
git clone https://github.com/Chintanpatel24/flint.git
3330
cd flint
@@ -36,7 +33,7 @@ bash update.sh
3633
npm audit fix --force
3734
```
3835

39-
### for devloping ,
36+
### For devloping ,
4037
```bash
4138
git clone --branch test-api --single-branch https://github.com/Chintanpatel24/flint.git
4239
```
@@ -45,31 +42,37 @@ git clone --branch test-api --single-branch https://github.com/Chintanpatel24/fl
4542

4643
## Features
4744

48-
### Note-Taking
45+
>### Note-Taking
4946
- Full **Markdown** support with live preview
5047
- **Wiki Links** (`[[Note Name]]`) to connect notes
5148
- **Tags** (`#tag`) for categorization
5249
- **Auto-save** with 600ms debounce
5350
- Split view (Editor + Preview)
5451
- Formatting toolbar (Bold, Italic, Heading, Quote, Code, Links, Lists)
5552

56-
### Graph View
53+
>### Graph View
5754
- Interactive **force-directed graph** visualization
5855
- Node size scales with connection count
5956
- Physics simulation - drag nodes, connected notes follow
6057
- Zoom, pan, search, depth filter
6158
- Curved edges between connected notes
6259

63-
### AI Agent (Python + Ollama + local models + APIs)
60+
>### AI Agent (Python + Ollama + GGUF + APIs)
6461
- **Real Python backend** that connects to Ollama locally
6562
- **Notes = Memory** - AI reads all your notes and graph connections
6663
- **Internet access** - AI searches Wikipedia for real-time info
6764
- **Works with ANY Ollama model** - llama3.2, mistral, codellama, phi3, etc.
6865
- **Streaming responses** in real-time
6966
- **Browser fallback** when agent is not running
7067

71-
### Local & Secure
68+
>### Local & Secure
7269
- **No cloud, no tracking** - all data stays on your device
7370
- **localStorage** for persistence
7471
- **No external API calls** (except Wikipedia when internet access is enabled)
7572
- **File System Access API** to open any local folder as a vault
73+
74+
---
75+
76+
> [!NOTE]
77+
> **It also works without any LLM or any API config** – with the built-in agent scripts & with the notes scanning (shown in the video), but it's dumb for the current time with the basic and minimal algorithms.
78+
> The workflow is **Ollama** > **GGUF** > **APIs** > **local-built agent script**.

0 commit comments

Comments
 (0)