Skip to content

Commit 3a77a0c

Browse files
committed
feat(docs): add docs for houdini
1 parent 6a83abf commit 3a77a0c

File tree

6 files changed

+32
-0
lines changed

6 files changed

+32
-0
lines changed

docs/docs.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Whodb is a powerful database management tool designed to simplify and enhance yo
44

55
## Features
66

7+
- **Conversate With Your Data:** No more wasting time crafting complex SQL queries - ask away!
78
- **Login Profiles & Authentication**: Securely log in to your database.
89
- **Database Selection**: Choose your database type, username, password, and specific database.
910
- **Side Bar Navigation**: Access different sections like Login Profile, Table Schema, Tables, Graph Visualization, and Scratchpad.
@@ -106,6 +107,37 @@ Once configured, you can switch between these profiles within the Whodb applicat
106107
- Select "Table Schema" from the side bar to view detailed information about your table schemas.
107108
<br /><p align="center"><img src="./images/schema-change.png" alt="Table Schema" width="400" /></p>
108109

110+
### Houdini
111+
112+
#### Overview
113+
114+
Houdini lets you interact with your data sources through a natural, conversational interface. Simply type in English, and Houdini will automatically understand and respond using the relevant data.
115+
116+
#### Getting started
117+
118+
- Visit [Ollama's website](https://ollama.com) and follow the installation instructions.
119+
- Once installed, run your desired model (e.g., Llama3.1) with the following command:
120+
121+
```bash
122+
ollama run ollama3.1
123+
```
124+
125+
#### Using Houdini
126+
- After installing Ollama, you’ll find the "Chat" feature available in the sidebar navigation.
127+
- This feature offers a ChatGPT-like experience, allowing you to engage in natural conversations with your data.
128+
129+
<br /><p align="center"><img src="./images/chat.png" alt="Chat" width="400" /></p>
130+
131+
**Note:** All data processing is done locally on your computer, ensuring complete privacy.
132+
133+
<details>
134+
<summary>View screenshots on examples</summary>
135+
<img src="./images/chat-example-1.png" alt="Chat example 1" width="100%" height="auto" />
136+
<img src="./images/chat-example-2.png" alt="Chat example 2" width="100%" height="auto" />
137+
<img src="./images/chat-example-3.png" alt="Chat example 3" width="100%" height="auto" />
138+
<img src="./images/chat-example-4.png" alt="Chat example 4" width="100%" height="auto" />
139+
</details>
140+
109141
### Tables
110142
111143
- Select "Tables" from the side bar to view and manage your tables.

docs/images/chat-example-1.png

270 KB
Loading

docs/images/chat-example-2.png

287 KB
Loading

docs/images/chat-example-3.png

316 KB
Loading

docs/images/chat-example-4.png

257 KB
Loading

docs/images/chat.png

194 KB
Loading

0 commit comments

Comments
 (0)