This is an automated email from the ASF dual-hosted git repository. jin pushed a commit to branch update-readme in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-commons.git
commit 65e4b58bd953c45936af0cc020427e879a3f47b8 Author: imbajin <[email protected]> AuthorDate: Tue Dec 12 15:33:59 2023 +0800 doc: update README for release --- README.md | 39 +++++++++++++++++++++++++++++++++------ hugegraph-common/README.md | 4 ++-- hugegraph-rpc/README.md | 7 ++----- 3 files changed, 37 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 556a3a3..d7e834e 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ [](https://www.apache.org/licenses/LICENSE-2.0.html) [](https://codecov.io/gh/hugegraph/hugegraph-common) [](https://mvnrepository.com/artifact/org.apache.hugegraph/hugegraph-common) +[](https://github.com/apache/incubator-hugegraph-commons/actions/workflows/codeql-analysis.yml) +[](https://github.com/apache/incubator-hugegraph-commons/actions/workflows/ci.yml) + hugegraph-commons is a common module for [HugeGraph](https://github.com/apache/hugegraph) and its peripheral components. 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 - Lock: atomic lock, key lock, lock group and lock manger - Config: register and load config option with security check - Event: listening and notification, do something asynchronously -- Iterator: some iterators with extra functions, map, filter, extend etc. -- Rest: RESTful client implemented on Jersey, POST, PUT, GET and DELETE -- Util: performance analyzer, version checker, numeric and Collection utils, log and exception utils etc. +- Iterator: some iterators with extra functions, map, filter, extend, etc. +- Rest: RESTful client implemented on OkHttp, POST, PUT, GET and DELETE +- Util: performance analyzer, version checker, numeric and Collection utils, log and exception utils, etc. - Rpc: rpc component for inner module communication, currently it's based on [Sofa-RPC](https://github.com/sofastack/sofa-rpc) +You could use import the dependencies in `maven` like this: + +```xml + <dependency> + <groupId>org.apache.hugegraph</groupId> + <artifactId>hugegraph-common</artifactId> + <version>1.2.0</version> + </dependency> +``` + ## Learn More 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: 3. [hugegraph-computer](https://github.com/apache/hugegraph-computer) (graph processing system - OLAP) 4. [hugegraph-website/doc](https://github.com/apache/hugegraph-doc) (include doc & website code) + + ## Contributing -Welcome to contribute, please see [`How to Contribute`](https://github.com/apache/hugegraph/blob/master/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! -Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to **greatly simplify** the PR and commit process. +[](https://github.com/apache/incubator-hugegraph-commons/graphs/contributors) ## Licence -Same as HugeGraph, hugegraph-commons is also licensed under `Apache 2.0` License. +Same as HugeGraph, hugegraph-commons are also licensed under [Apache 2.0](./LICENSE) License. + +### Contact Us + +--- + + - [GitHub Issues](https://github.com/apache/incubator-hugegraph-commons/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://raw.githubusercontent.com/apache/incubator-hugegraph-doc/master/assets/images/wechat.png"; alt="QR png" width="350"/> diff --git a/hugegraph-common/README.md b/hugegraph-common/README.md index ca2f80d..8614ba1 100644 --- a/hugegraph-common/README.md +++ b/hugegraph-common/README.md @@ -15,9 +15,9 @@ its components. - Lock: atomic lock, key lock, lock group and lock manger - Config: register and load config option with security check - Event: listening and notification, do something asynchronously -- Iterator: some iterators with extra functions, map, filter, extend etc. +- Iterator: some iterators with extra functions, map, filter, extend, etc. - Rest: RESTful client implemented on Jersey, POST, PUT, GET and DELETE -- Util: Performance analyzer, version checker, numeric and Collection utils, log and exception utils etc. +- Util: Performance analyzer, version checker, numeric and Collection utils, log and exception utils, etc. ## Licence The same as HugeGraph, hugegraph-common is also licensed under Apache 2.0 License. diff --git a/hugegraph-rpc/README.md b/hugegraph-rpc/README.md index 17a17b6..c316a9c 100644 --- a/hugegraph-rpc/README.md +++ b/hugegraph-rpc/README.md @@ -6,11 +6,8 @@ HugeGraph Database RPC component, currently it's based on [Sofa-RPC](https://git ## Learn More -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. - -## Contributing - -Welcome to contribute to HugeGraph, please see [`How to Contribute`](CONTRIBUTING.md) for more information. +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. ## License
![https://raw.githubusercontent.com/apache/incubator-hugegraph-doc/master/assets/images/wechat.png"](https://raw.githubusercontent.com/apache/incubator-hugegraph-doc/master/assets/images/wechat.png"){kind=link}