Skip to content

Commit 8bf96b4

Browse files
committed
docs: update links to point to standalone repos and add bench reference
Replace internal doc links for NodeDB-Lite and ndb CLI with their respective GitHub repository URLs. Update NodeDB Admin to NodeDB Studio and add a link to nodedb-bench.
1 parent 4ce74fc commit 8bf96b4

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ All seven engines as an embedded library. Linux, macOS, Windows, Android, iOS, a
110110
- **Lite + Origin** -- offline-first with CRDT sync. Writes happen locally, deltas merge to Origin when online. Multiple devices converge regardless of order.
111111
- **Same API** -- the `NodeDb` trait is identical across Lite and Origin. Switch between embedded and server without changing application code.
112112

113-
See [NodeDB-Lite docs](docs/lite.md) for platform details and sync configuration.
113+
See [NodeDB-Lite](https://github.com/NodeDB-Lab/nodedb-lite) for platform details and sync configuration.
114114

115115
## Key Features
116116

@@ -126,8 +126,9 @@ See [NodeDB-Lite docs](docs/lite.md) for platform details and sync configuration
126126

127127
## Tools
128128

129-
- **[`ndb`](docs/cli.md)** -- Native CLI with TUI, syntax highlighting, and tab completion. Alternative to `psql`.
130-
- **NodeDB Admin** -- Web-based GUI for managing collections, browsing data, and monitoring. _(coming soon)_
129+
- **[`ndb`](https://github.com/NodeDB-Lab/nodedb-cli)** -- Native CLI with TUI, syntax highlighting, and tab completion. Alternative to `psql`.
130+
- **[NodeDB Studio](https://github.com/NodeDB-Lab/nodedb-studio)** -- GUI client for managing collections, browsing data, and monitoring. _(coming soon)_
131+
- **[nodedb-bench](https://github.com/NodeDB-Lab/nodedb-bench)** -- Performance benchmarks against competing databases.
131132

132133
## Documentation
133134

@@ -136,7 +137,7 @@ See [NodeDB-Lite docs](docs/lite.md) for platform details and sync configuration
136137
- [Engine Guides](docs/README.md) -- Deep dives into each engine
137138
- [Security](docs/security/README.md) -- Auth, RBAC, RLS, audit, multi-tenancy
138139
- [Real-Time](docs/real-time.md) -- CDC, pub/sub, LIVE SELECT
139-
- [NodeDB-Lite](docs/lite.md) -- Embedded edge database
140+
- [NodeDB-Lite](https://github.com/NodeDB-Lab/nodedb-lite) -- Embedded edge database
140141
- [AI Patterns](docs/ai/README.md) -- RAG, GraphRAG, agent memory, feature store
141142

142143
## Building from Source

0 commit comments

Comments
 (0)