-
Notifications
You must be signed in to change notification settings - Fork 521
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: improve the UI & content in README #2227
Changes from 10 commits
9be59ed
faf03dc
4ee0e9a
b1e0d5d
e85bba6
a254fab
36ec593
9a0989a
3501431
8176b6a
6274a6a
34fba99
bf65bd9
120efd6
25cb3f4
ac32494
ff52f2f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,37 @@ | ||
<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"> | ||
|
||
[![License](https://img.shields.io/badge/license-Apache%202-0E78BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) | ||
[![HugeGraph-CI](https://github.com/apache/incubator-hugegraph/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-hugegraph/actions/workflows/ci.yml) | ||
[![CodeQL](https://github.com/apache/incubator-hugegraph/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/incubator-hugegraph/actions/workflows/codeql-analysis.yml) | ||
[![License checker](https://github.com/apache/incubator-hugegraph/actions/workflows/licence-checker.yml/badge.svg)](https://github.com/apache/incubator-hugegraph/actions/workflows/licence-checker.yml) | ||
[![Codecov](https://codecov.io/gh/apache/hugegraph/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/hugegraph) | ||
[![Codecov](https://codecov.io/gh/apache/incubator-hugegraph/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/incubator-hugegraph) | ||
[![GitHub Releases Downloads](https://img.shields.io/github/downloads/apache/hugegraph/total.svg)](https://github.com/apache/hugegraph/releases) | ||
[![stars](https://img.shields.io/github/stars/apache/hugegraph)](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 | ||
|
||
## 🎉 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 | ||
- 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`, `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 | ||
|
||
## 🚀 Quick Start | ||
|
||
### 1. Docker Way | ||
|
||
|
@@ -55,27 +59,30 @@ 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) | ||
|
||
## Contributing | ||
|
||
Welcome to contribute to HugeGraph, please see [`How to Contribute`](CONTRIBUTING.md) for more information. | ||
## 🤝 Contributing | ||
|
||
Welcome to contribute to HugeGraph, please see [`How to Contribute`](CONTRIBUTING.md) & [Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) for more information. | ||
|
||
## License | ||
Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to greatly simplify the PR and commit process. | ||
|
||
HugeGraph is licensed under Apache 2.0 License. | ||
|
||
## Thanks | ||
## 🌹 Thanks | ||
|
||
HugeGraph relies on the [TinkerPop](http://tinkerpop.apache.org) framework, we refer to the storage structure of Titan and the schema definition of DataStax. | ||
Thanks to TinkerPop, thanks to Titan, thanks to DataStax. Thanks to all other organizations or authors who contributed to the project. | ||
|
||
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 | ||
[![contributors graph](https://contrib.rocks/image?repo=apache/hugegraph)](https://github.com/apache/incubator-hugegraph/graphs/contributors) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. wonder to know if we could reduce the size of this contri-graph? (like 50%?) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes, I change the size to take more small space There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
--- | ||
|
||
## ☎️ Contact Us | ||
|
||
- [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues): Feedback on usage issues and functional requirements (quick response) | ||
- Feedback Email: [[email protected]](mailto:[email protected]) ([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"/> | ||
<div align="center"> | ||
<img src="https://github.com/apache/incubator-hugegraph-doc/blob/master/assets/images/wechat.png?raw=true" alt="QR png" width="300"/> | ||
</div> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I leave it with left side |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the icon doesn't seem to be able to accurately express the meaning, we would rather remove it, the same below (until "Contributing").
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I will remove all icon to keep same style.