Skip to content
This repository was archived by the owner on Oct 10, 2025. It is now read-only.

Commit 06890e1

Browse files
mewimmewim
authored
Update README (#6053)
1 parent 23551e3 commit 06890e1

File tree

1 file changed

+50
-44
lines changed

1 file changed

+50
-44
lines changed

‎README.md‎

Lines changed: 50 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
<div align="center">
2-
<picture>
3-
<source srcset="https://kuzudb.com/img/kuzu-logo-dark.png" media="(prefers-color-scheme: dark)">
4-
<img src="https://kuzudb.com/img/kuzu-logo.png" height="100" alt="Kuzu Logo">
5-
</picture>
6-
</div>
7-
8-
<br>
9-
10-
<p align="center">
11-
<a href="https://github.com/kuzudb/kuzu/actions">
12-
<img src="https://github.com/kuzudb/kuzu/actions/workflows/ci-workflow.yml/badge.svg?branch=master" alt="Github Actions Badge"></a>
13-
<a href="https://discord.gg/VtX2gw9Rug">
14-
<img src="https://img.shields.io/discord/1196510116388806837?logo=discord" alt="discord" /></a>
15-
<a href="https://twitter.com/kuzudb">
16-
<img src="https://img.shields.io/badge/follow-@kuzudb-1DA1F2?logo=twitter" alt="twitter"></a>
17-
</p>
1+
> [!NOTE]
2+
> Kuzu is working on something new!
3+
>
4+
> We are archiving the KuzuDB project here: https://github.com/kuzudb/kuzu/
5+
>
6+
> For those using Kuzu currently, prior Kuzu releases will continue to be usable in the same way without modifications to your code.
7+
>
8+
> If you are also using extensions, moving forward you have two options:
9+
> 1. we have a new release 0.11.3 that bundles many (but not all) of the extensions, so you can migrate to 0.11.3; or
10+
> 2. you can follow the [instructions here](http://kuzudb.github.io/docs/extensions/#host-your-own-extension-server) to run a local extension server.
11+
>
12+
> Further, some of our resources are moving from our website to GitHub:
13+
> - Docs: http://kuzudb.github.io/docs
14+
> - Blog: http://kuzudb.github.io/blog
15+
>
16+
> We thank you for being early users of Kuzu and making Kuzu better over the last few years!
17+
1818

1919
# Kuzu
2020
Kuzu is an embedded graph database built for query speed and scalability. Kuzu is optimized for handling complex analytical workloads
@@ -31,41 +31,47 @@ on very large databases and provides a set of retrieval features, such as a full
3131
- Serializable ACID transactions
3232
- Wasm (WebAssembly) bindings for fast, secure execution in the browser
3333

34-
Kuzu is being developed by [Kùzu Inc.](https://kuzudb.com/) and
35-
is available under a permissible license. So try it out and help us make it better! We welcome your feedback and feature requests.
36-
37-
## Installation
34+
Kuzu was initially developed by Kùzu Inc. It is available under a permissible license.
3835

39-
| Language | Installation |
40-
| -------- |------------------------------------------------------------------------|
41-
| Python | `pip install kuzu` |
42-
| NodeJS | `npm install kuzu` |
43-
| Rust | `cargo add kuzu` |
44-
| Go | `go get github.com/kuzudb/go-kuzu` |
45-
| Swift | [kuzu-swift](https://github.com/kuzudb/kuzu-swift) |
46-
| Java | [Maven Central](https://central.sonatype.com/artifact/com.kuzudb/kuzu) |
47-
| C/C++ | [precompiled binaries](https://github.com/kuzudb/kuzu/releases/latest) |
48-
| CLI | [precompiled binaries](https://github.com/kuzudb/kuzu/releases/latest) |
36+
## Docs and Blog
4937

50-
To learn more about installation, see our [Installation](https://docs.kuzudb.com/installation) page.
38+
To learn more about Kuzu, see our [Documentation](https://kuzudb.github.io/docs) and [Blog](https://kuzudb.github.io/blog) page.
5139

5240
## Getting Started
5341

54-
Refer to our [Getting Started](https://docs.kuzudb.com/get-started/) page for your first example.
42+
Refer to our [Getting Started](https://kuzudb.github.io/docs/get-started/) page for your first example.
5543

56-
## Build from Source
44+
## Extensions
45+
Kuzu has an extension framework that users can dynamically load the functionality you need at runtime.
46+
We've developed a list of [official extensions](https://kuzudb.github.io/docs/extensions/#available-extensions) that you can use to extend Kuzu's functionality.
5747

58-
You can build from source using the instructions provided in the [developer guide](https://docs.kuzudb.com/developer-guide).
48+
Kuzu requires you to install the extension before loading and using it.
49+
Note that Kuzu no longer provides the official extension server, where you can directly install any official extensions.
5950

60-
## Contributing
61-
We welcome contributions to Kuzu. If you are interested in contributing to Kuzu, please read our [Contributing Guide](CONTRIBUTING.md).
51+
If you've upgraded to the latest version v0.11.3, Kuzu has pre-installed four commonly used extensions (`algo`, `fts`, `json`, `vector`) for you.
52+
You do not need to manually INSTALL these extensions.
6253

63-
## License
64-
By contributing to Kuzu, you agree that your contributions will be licensed under the [MIT License](LICENSE).
54+
For Kuzu versions before v0.11.3, or to install extensions that haven't been pre-installed, you have to set up a local extension server.
55+
The instructions of setting up a local extension server can be found below.
56+
57+
### Host your own extension server
58+
59+
The extension server is based on NGINX and is hosted on [GitHub](https://ghcr.io/kuzudb/extension-repo). You can pull the Docker image and run it in your environment:
6560

66-
## Support
67-
We provide professional support for using Kuzu, ensuring timely responses and flexible coverage. Please visit [here](https://kuzudb.com/#support)
68-
for more information.
61+
```bash
62+
docker pull ghcr.io/kuzudb/extension-repo:latest
63+
docker run -d -p 8080:80 ghcr.io/kuzudb/extension-repo:latest
64+
```
6965

70-
## Contact
71-
You can contact us at [[email protected]](mailto:[email protected]) or [join our Discord community](https://discord.gg/VtX2gw9Rug).
66+
In this example, the extension server will be available at `http://localhost:8080`. You can then install extensions from your server by appending the `FROM` clause to the `INSTALL` command:
67+
68+
```cypher
69+
INSTALL <EXTENSION_NAME> FROM 'http://localhost:8080/';
70+
```
71+
72+
## Build from Source
73+
74+
You can build from source using the instructions provided in the [developer guide](https://kuzudb.github.io/docs/developer-guide).
75+
76+
## License
77+
Kuzu is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)