Skip to content
This repository was archived by the owner on Feb 24, 2026. It is now read-only.

Commit 44f99e9

Browse files
authored
doc: update README for release (#138)
1 parent dcf3752 commit 44f99e9

File tree

3 files changed

+37
-13
lines changed

3 files changed

+37
-13
lines changed

README.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
[![License](https://img.shields.io/badge/license-Apache%202-0E78BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
44
[![codecov](https://codecov.io/gh/hugegraph/hugegraph-common/branch/master/graph/badge.svg)](https://codecov.io/gh/hugegraph/hugegraph-common)
55
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.hugegraph/hugegraph-common/badge.svg)](https://mvnrepository.com/artifact/org.apache.hugegraph/hugegraph-common)
6+
[![CodeQL](https://github.com/apache/incubator-hugegraph-commons/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/incubator-hugegraph-commons/actions/workflows/codeql-analysis.yml)
7+
[![hugegraph-commons ci](https://github.com/apache/incubator-hugegraph-commons/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-hugegraph-commons/actions/workflows/ci.yml)
8+
69

710
hugegraph-commons is a common module for [HugeGraph](https://github.com/apache/hugegraph) and its peripheral components.
811
hugegraph-commons encapsulates locks, configurations, events, iterators, rest and some
@@ -13,11 +16,21 @@ numeric or collection util classes to simplify the development of HugeGraph and
1316
- Lock: atomic lock, key lock, lock group and lock manger
1417
- Config: register and load config option with security check
1518
- Event: listening and notification, do something asynchronously
16-
- Iterator: some iterators with extra functions, map, filter, extend etc.
17-
- Rest: RESTful client implemented on Jersey, POST, PUT, GET and DELETE
18-
- Util: performance analyzer, version checker, numeric and Collection utils, log and exception utils etc.
19+
- Iterator: some iterators with extra functions, map, filter, extend, etc.
20+
- Rest: RESTful client implemented on OkHttp, POST, PUT, GET and DELETE
21+
- Util: performance analyzer, version checker, numeric and Collection utils, log and exception utils, etc.
1922
- Rpc: rpc component for inner module communication, currently it's based on [Sofa-RPC](https://github.com/sofastack/sofa-rpc)
2023

24+
You could use import the dependencies in `maven` like this:
25+
26+
```xml
27+
<dependency>
28+
<groupId>org.apache.hugegraph</groupId>
29+
<artifactId>hugegraph-common</artifactId>
30+
<version>1.2.0</version>
31+
</dependency>
32+
```
33+
2134
## Learn More
2235

2336
The [doc page](https://hugegraph.apache.org/docs/) contains more information about hugegraph modules.
@@ -28,12 +41,26 @@ And here are links of other repositories:
2841
3. [hugegraph-computer](https://github.com/apache/hugegraph-computer) (graph processing system - OLAP)
2942
4. [hugegraph-website/doc](https://github.com/apache/hugegraph-doc) (include doc & website code)
3043

44+
45+
3146
## Contributing
3247

33-
Welcome to contribute, please see [`How to Contribute`](https://github.com/apache/hugegraph/blob/master/CONTRIBUTING.md) for more information
48+
- Welcome to contribute to HugeGraph, please see [`How to Contribute`](CONTRIBUTING.md) & [Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) for more information.
49+
- Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to greatly simplify the PR and commit process.
50+
- Thank you to all the people who already contributed to HugeGraph!
3451

35-
Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to **greatly simplify** the PR and commit process.
52+
[![contributors graph](https://contrib.rocks/image?repo=apache/hugegraph-commons)](https://github.com/apache/incubator-hugegraph-commons/graphs/contributors)
3653

3754
## Licence
3855

39-
Same as HugeGraph, hugegraph-commons is also licensed under `Apache 2.0` License.
56+
Same as HugeGraph, hugegraph-commons are also licensed under [Apache 2.0](./LICENSE) License.
57+
58+
### Contact Us
59+
60+
---
61+
62+
- [GitHub Issues](https://github.com/apache/incubator-hugegraph-commons/issues): Feedback on usage issues and functional requirements (quick response)
63+
- Feedback Email: [dev@hugegraph.apache.org](mailto:dev@hugegraph.apache.org) ([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/) only)
64+
- WeChat public account: Apache HugeGraph, welcome to scan this QR code to follow us.
65+
66+
<img src="https://raw.githubusercontent.com/apache/incubator-hugegraph-doc/master/assets/images/wechat.png" alt="QR png" width="350"/>

hugegraph-common/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ its components.
1515
- Lock: atomic lock, key lock, lock group and lock manger
1616
- Config: register and load config option with security check
1717
- Event: listening and notification, do something asynchronously
18-
- Iterator: some iterators with extra functions, map, filter, extend etc.
18+
- Iterator: some iterators with extra functions, map, filter, extend, etc.
1919
- Rest: RESTful client implemented on Jersey, POST, PUT, GET and DELETE
20-
- Util: Performance analyzer, version checker, numeric and Collection utils, log and exception utils etc.
20+
- Util: Performance analyzer, version checker, numeric and Collection utils, log and exception utils, etc.
2121

2222
## Licence
2323
The same as HugeGraph, hugegraph-common is also licensed under Apache 2.0 License.

hugegraph-rpc/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,8 @@ HugeGraph Database RPC component, currently it's based on [Sofa-RPC](https://git
66

77
## Learn More
88

9-
The [project homepage](https://hugegraph.github.io/hugegraph-doc/) contains more information on HugeGraph and provides links to documentation, getting-started guides and release downloads.
10-
11-
## Contributing
12-
13-
Welcome to contribute to HugeGraph, please see [`How to Contribute`](CONTRIBUTING.md) for more information.
9+
The [project homepage](https://hugegraph.github.io/hugegraph-doc/) contains more information on
10+
HugeGraph and provides links to documentation, getting-started guides and release downloads.
1411

1512
## License
1613

0 commit comments

Comments
 (0)