You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: improve README for developer experience (#3)
* docs: rewrite README with quickstart and usage examples
* fix(docs): use newline-separated tables in README example
---------
Co-authored-by: Eddie A Tejeda <669988+eddietejeda@users.noreply.github.com>
Copy file name to clipboardExpand all lines: README.md
+44-14Lines changed: 44 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,41 +1,55 @@
1
1
# hotdata-llamaindex
2
2
3
-
LlamaIndex tools for [Hotdata](https://hotdata.dev), built on **hotdata-runtime**.
4
-
5
-
## Features
6
-
7
-
-**SQL tool** — run workspace SQL and return JSON rows for agents
8
-
-**Managed database tools** — list, create, and load parquet into Hotdata-owned catalogs (replaces legacy dataset uploads)
3
+
Give your [LlamaIndex](https://www.llamaindex.ai/) agents access to [Hotdata](https://hotdata.dev) — run SQL against your workspace connections and work with managed databases.
9
4
10
5
## Install
11
6
12
7
```bash
13
8
pip install hotdata-llamaindex
14
9
```
15
10
16
-
Requires `HOTDATA_API_KEY`. Optionally set `HOTDATA_WORKSPACE`, `HOTDATA_API_URL`, or `HOTDATA_SANDBOX`.
11
+
## Authentication
12
+
13
+
Set `HOTDATA_API_KEY` in your environment. Optionally set `HOTDATA_WORKSPACE` to pin a specific workspace (the first available workspace is used if unset).
17
14
18
-
## Usage
15
+
## Quickstart
19
16
20
17
```python
18
+
from llama_index.core.agent.workflow import FunctionAgent
0 commit comments