You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hugegraph.apache.org by ji...@apache.org on 2023/06/12 16:04:36 UTC
[incubator-hugegraph] branch master updated: chore: improve the UI & content in README (#2227)
This is an automated email from the ASF dual-hosted git repository.
jin 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 b836426db chore: improve the UI & content in README (#2227)
b836426db is described below
commit b836426db01567a6d912edf9fd0600dd624de62d
Author: Lionztt <38...@users.noreply.github.com>
AuthorDate: Tue Jun 13 00:04:28 2023 +0800
chore: improve the UI & content in README (#2227)
* feat: change contributor img size to normal size
---------
Co-authored-by: imbajin <ji...@apache.org>
---
README.md | 42 ++++++++++++++++++++++++++----------------
1 file changed, 26 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index c56eea2cb..edc7c97bb 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,27 @@
-<div align="center">
- <img width="720" alt="hugegraph-logo" src="https://user-images.githubusercontent.com/17706099/149281100-c296db08-2861-4174-a31f-e2a92ebeeb72.png" style="zoom:100%;" />
-</div>
+<h1 align="center">
+ <img width="720" alt="hugegraph-logo" src="https://github.com/apache/incubator-hugegraph/assets/38098239/e02ffaed-4562-486b-ba8f-e68d02bb0ea6" style="zoom:100%;" />
+</h1>
-<p align="center">
- A graph database that supports more than 10 billion data, high performance and scalability
-</p>
-<hr/>
+<h3 align="center">A graph database that supports more than 10 billion data, high performance and scalability</h3>
-# Apache HugeGraph
+<div align="center">
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://github.com/apache/incubator-hugegraph/actions/workflows/ci.yml)
[](https://github.com/apache/incubator-hugegraph/actions/workflows/codeql-analysis.yml)
[](https://github.com/apache/incubator-hugegraph/actions/workflows/licence-checker.yml)
-[](https://codecov.io/gh/apache/hugegraph)
+[](https://app.codecov.io/gh/apache/incubator-hugegraph)
[](https://github.com/apache/hugegraph/releases)
+[](https://github.com/apache/incubator-hugegraph/stargazers)
+
+</div>
+
+## 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 accomplished through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful 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
@@ -27,6 +30,7 @@ Billions of vertices and edges can be easily stored into and queried from HugeGr
- Plug-in Backend Store Driver Framework, support `RocksDB`, `Cassandra`, `HBase`, `ScyllaDB`, and `MySQL/Postgre` now and easy to add other backend store driver if needed
- Integration with `Flink/Spark/HDFS`, and friendly to connect other big data platforms
+
## Quick Start
### 1. Docker Way
@@ -55,13 +59,19 @@ And here are links of other **HugeGraph** component/repositories:
3. [hugegraph-commons](https://github.com/apache/incubator-hugegraph-commons) (**common & rpc** module)
4. [hugegraph-website](https://github.com/apache/incubator-hugegraph-doc) (**doc & website** code)
+## License
+
+HugeGraph is licensed under Apache 2.0 License.
+
+
## Contributing
-Welcome to contribute to HugeGraph, please see [`How to Contribute`](CONTRIBUTING.md) for more information.
+- Welcome to contribute to HugeGraph, please see [`How to Contribute`](CONTRIBUTING.md) & [Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) for more information.
+- Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to greatly simplify the PR and commit process.
+- Thank you to all the people who already contributed to HugeGraph!
-## License
+[](https://github.com/apache/incubator-hugegraph/graphs/contributors)
-HugeGraph is licensed under Apache 2.0 License.
## Thanks
@@ -70,12 +80,12 @@ Thanks to TinkerPop, thanks to Titan, thanks to DataStax. Thanks to all other or
You are welcome to contribute to HugeGraph, and we are looking forward to working with you to build an excellent open source community.
-### Contact Us
----
+## Contact Us
- - [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues): Feedback on usage issues and functional requirements (quick response)
+- [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues): Feedback on usage issues and functional requirements (quick response)
- Feedback Email: [dev@hugegraph.apache.org](mailto:dev@hugegraph.apache.org) ([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/) only)
- WeChat public account: Apache HugeGraph, welcome to scan this QR code to follow us.
- <img src="https://github.com/apache/incubator-hugegraph-doc/blob/master/assets/images/wechat.png?raw=true" alt="QR png" width="350"/>
+ <img src="https://github.com/apache/incubator-hugegraph-doc/blob/master/assets/images/wechat.png?raw=true" alt="QR png" width="300"/>
+