This is an automated email from the ASF dual-hosted git repository.
vgalaxies pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph.git
The following commit(s) were added to refs/heads/master by this push:
new ca501a202 doc: enhance words in README (#2734)
ca501a202 is described below
commit ca501a202cd9b73625a7cf8bf16c6e6640e6098e
Author: Bobby Warner <[email protected]>
AuthorDate: Thu Feb 20 02:29:53 2025 -0600
doc: enhance words in README (#2734)
Co-authored-by: imbajin <[email protected]>
---
README.md | 41 ++++++++++++++++++++++++-----------------
1 file changed, 24 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index eaa95d568..80e5186dd 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
<img width="720" alt="hugegraph-logo"
src="https://github.com/apache/hugegraph/assets/38098239/e02ffaed-4562-486b-ba8f-e68d02bb0ea6";
style="zoom:100%;" />
</h1>
-<h3 align="center">A graph database that supports more than 10 billion data,
high performance and scalability</h3>
+<h3 align="center">A graph database that supports more than 10 billion
vertices & edges, high performance and scalability</h3>
<div align="center">
@@ -15,15 +15,15 @@
## What is Apache HugeGraph?
-[HugeGraph](https://hugegraph.apache.org/) is a fast-speed and highly-scalable
[graph database](https://en.wikipedia.org/wiki/Graph_database).
-Billions of vertices and edges can be easily stored into and queried from
HugeGraph due to its excellent OLTP ability.
-As compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/)
framework, various complicated graph queries can be
-achieved through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a
powerful graph traversal language).
+[HugeGraph](https://hugegraph.apache.org/) is a fast and highly-scalable
[graph database](https://en.wikipedia.org/wiki/Graph_database).
+Billions of vertices and edges can be easily stored into and queried from
HugeGraph due to its excellent OLTP capabilities.
+HugeGraph is compliant with the [Apache TinkerPop
3](https://tinkerpop.apache.org/) framework allowing complicated graph queries
to be
+achieved through the powerful
[Gremlin](https://tinkerpop.apache.org/gremlin.html) graph traversal language.
## Features
-- Compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/), support
[Gremlin](https://tinkerpop.apache.org/gremlin.html) &
[Cypher](https://en.wikipedia.org/wiki/Cypher) language
+- Compliant to [Apache TinkerPop 3](https://tinkerpop.apache.org/), supports
[Gremlin](https://tinkerpop.apache.org/gremlin.html) &
[Cypher](https://en.wikipedia.org/wiki/Cypher) language
- Schema Metadata Management, including VertexLabel, EdgeLabel, PropertyKey
and IndexLabel
- Multi-type Indexes, supporting exact query, range query and complex
conditions combination query
- Plug-in Backend Store Driver Framework, support `RocksDB`/`HStore`, `HBase`,
`Cassandra/ScyllaDB`, and `MySQL/Postgre` now and easy to add another backend
store driver if needed
@@ -32,27 +32,34 @@ achieved through
[Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful
## Quick Start
-### 1. Docker Way (Convenient for Test)
+### 1. Docker (For Test)
-We can use `docker run -itd --name=graph -p 8080:8080
hugegraph/hugegraph:1.3.0` to quickly start an inner
-HugeGraph server with `RocksDB` (in backgrounds) for **test/dev**.
-You can visit [doc
page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy)
or
+Use Docker to quickly start a HugeGraph server with `RocksDB` (in the
background) for **testing or development**:
+
+```
+# (Optional)
+# 1. add "-e PASSWORD=xxx" to enable the auth system
+# 2. add "-e PRELOAD="true" to auto-load a sample graph
+docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.5.0
+```
+
+Please visit [doc
page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy)
or
the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more
details. ([Docker Compose](./hugegraph-server/hugegraph-dist/docker/example))
> Note:
->
-> 1. The docker image of hugegraph is a convenience release, but not
**official distribution** artifacts. You can find more details from [ASF
Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub).
->
-> 2. Recommend to use `release tag` (like `1.3.0`/`1.5.0`) for the stable
version. Use `latest` tag to experience the newest functions in development.
+> 1. The Docker image of HugeGraph is a convenience release, but not
**official distribution** artifacts. You can find more details from [ASF
Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub).
+> 2. Recommend to use `release tag` (like `1.5.0`/`1.x.0`) for the stable
version. Use `latest` tag to experience the newest functions in development.
-### 2. Download Way
+### 2. Download
Visit [Download Page](https://hugegraph.apache.org/docs/download/download/)
and refer the
[doc](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#32-download-the-binary-tar-tarball)
to download the latest release package and start the server.
-### 3. Source Building Way
+**Note:** if you want to use it in the production environment or expose it to
the public network, must enable the
[AuthSystem](https://hugegraph.apache.org/docs/config/config-authentication/)
to ensure safe.
+
+### 3. Build From Source
-Visit [Source Building
Page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation)
and follow the
+Visit [Build From Source
Page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation)
and follow the
steps to build the source code and start the server.
The project [doc page](https://hugegraph.apache.org/docs/) contains more
information on HugeGraph
