Skip to content

Commit ca501a2

Browse files
bobbywarnerimbajin
andauthored
doc: enhance words in README (#2734)
Co-authored-by: imbajin <jin@apache.org>
1 parent 57e9f56 commit ca501a2

File tree

1 file changed

+24
-17
lines changed

1 file changed

+24
-17
lines changed

README.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img width="720" alt="hugegraph-logo" src="https://github.com/apache/hugegraph/assets/38098239/e02ffaed-4562-486b-ba8f-e68d02bb0ea6" style="zoom:100%;" />
33
</h1>
44

5-
<h3 align="center">A graph database that supports more than 10 billion data, high performance and scalability</h3>
5+
<h3 align="center">A graph database that supports more than 10 billion vertices & edges, high performance and scalability</h3>
66

77
<div align="center">
88

@@ -15,15 +15,15 @@
1515

1616
## What is Apache HugeGraph?
1717

18-
[HugeGraph](https://hugegraph.apache.org/) is a fast-speed and highly-scalable [graph database](https://en.wikipedia.org/wiki/Graph_database).
19-
Billions of vertices and edges can be easily stored into and queried from HugeGraph due to its excellent OLTP ability.
20-
As compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/) framework, various complicated graph queries can be
21-
achieved through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful graph traversal language).
18+
[HugeGraph](https://hugegraph.apache.org/) is a fast and highly-scalable [graph database](https://en.wikipedia.org/wiki/Graph_database).
19+
Billions of vertices and edges can be easily stored into and queried from HugeGraph due to its excellent OLTP capabilities.
20+
HugeGraph is compliant with the [Apache TinkerPop 3](https://tinkerpop.apache.org/) framework allowing complicated graph queries to be
21+
achieved through the powerful [Gremlin](https://tinkerpop.apache.org/gremlin.html) graph traversal language.
2222

2323

2424
## Features
2525

26-
- 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
26+
- 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
2727
- Schema Metadata Management, including VertexLabel, EdgeLabel, PropertyKey and IndexLabel
2828
- Multi-type Indexes, supporting exact query, range query and complex conditions combination query
2929
- 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
3232

3333
## Quick Start
3434

35-
### 1. Docker Way (Convenient for Test)
35+
### 1. Docker (For Test)
3636

37-
We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.3.0` to quickly start an inner
38-
HugeGraph server with `RocksDB` (in backgrounds) for **test/dev**.
39-
You can visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) or
37+
Use Docker to quickly start a HugeGraph server with `RocksDB` (in the background) for **testing or development**:
38+
39+
```
40+
# (Optional)
41+
# 1. add "-e PASSWORD=xxx" to enable the auth system
42+
# 2. add "-e PRELOAD="true" to auto-load a sample graph
43+
docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.5.0
44+
```
45+
46+
Please visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) or
4047
the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more details. ([Docker Compose](./hugegraph-server/hugegraph-dist/docker/example))
4148

4249
> Note:
43-
>
44-
> 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).
45-
>
46-
> 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.
50+
> 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).
51+
> 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.
4752
48-
### 2. Download Way
53+
### 2. Download
4954

5055
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)
5156
to download the latest release package and start the server.
5257

53-
### 3. Source Building Way
58+
**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.
59+
60+
### 3. Build From Source
5461

55-
Visit [Source Building Page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation) and follow the
62+
Visit [Build From Source Page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation) and follow the
5663
steps to build the source code and start the server.
5764

5865
The project [doc page](https://hugegraph.apache.org/docs/) contains more information on HugeGraph

0 commit comments

Comments
 (0)