Skip to content
This repository was archived by the owner on Jan 26, 2026. It is now read-only.

Commit b6a3a5b

Browse files
authored
Revise README for CypherDB project details
Updated README to reflect the fork of Kuzu and clarify project goals and features.
1 parent 5d63def commit b6a3a5b

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
1-
# CypherDB - SQLite for graphs
1+
# CypherDB
2+
3+
## About CypherDB
4+
5+
CypherDB is a fork of [Kuzu](https://github.com/kuzudb/kuzu), an embedded graph database that is now a public archive.
6+
7+
The openCypher organization is evaluating how we can best support this
8+
technology and its community. Our initial goals are to:
9+
10+
1. Explore whether CypherDB can serve as a reference implementation of
11+
ISO-GQL's mandatory features
12+
2. Determine what sustainable open source stewardship looks like for this project
13+
3. Learn about the community of users and contributors
14+
15+
**This is an evaluation phase.** We're committed to transparent communication
16+
with both the existing Kuzu community and potential contributors as we determine
17+
the best path forward. Our decisions will be guided by what serves the broader
18+
graph database ecosystem.
19+
20+
The extensive `s/kuzu/cypherdb/` is to acknowledgement that the original project
21+
name belongs to the original commercial venture, and this is not that.
22+
23+
## Database Features
224

325
CypherDB is an embedded graph database. It is optimized for handling complex analytical workloads
426
on very large databases and provides a set of retrieval features, such as a full text search and vector indices.
@@ -16,13 +38,13 @@ Core features:
1638
- Serializable ACID transactions
1739
- Wasm (WebAssembly) bindings for fast, secure execution in the browser
1840

19-
CypherDB was initially developed by Neo4j Inc as CypherDB. CypherDB's focus is on supporting an open-source,
20-
community-based project that is a reference implementation of [openCypher](https://opencypher.org).
41+
The focus of this fork is on supporting an open-source, community-based project that is a reference
42+
implementation of [openCypher](https://opencypher.org).
2143

2244

2345
## Build from Source
2446

25-
You can build from source using the instructions provided in the [developer guide](https://kuzu.github.io/docs/developer-guide).
47+
You can build from source using the instructions provided in the [developer guide](https://opencypher.github.io/cypherdb/developer-guide/).
2648

2749
## License
28-
CypherDB is licensed under the [MIT License](LICENSE) by [Neo4j, Inc.](https://neo4j.com).
50+
CypherDB is licensed under the [MIT License](LICENSE), with initial support from [Neo4j, Inc.](https://neo4j.com).

0 commit comments

Comments
 (0)