From 2efcd88c1aadbfd2e47543a6188d141ccee31cf8 Mon Sep 17 00:00:00 2001 From: imbajin <17706099+imbajin@users.noreply.github.com> Date: Fri, 15 Apr 2022 15:41:37 +0800 Subject: [PATCH 1/2] doc: add readme for toolchains --- README.md | 23 +++++++++++++++++++++++ hugegraph-client/README.md | 4 ++++ hugegraph-hubble/README.md | 6 +++--- hugegraph-loader/README.md | 4 ++-- hugegraph-tools/README.md | 2 +- 5 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..dadc5776a --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# hugegraph-toolchains + +[![License](https://img.shields.io/badge/license-Apache%202-0E78BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) +[![Build Status](https://github.com/hugegraph/hugegraph-loader/actions/workflows/ci.yml/badge.svg)](https://github.com/hugegraph/hugegraph-loader/actions/workflows/ci.yml) +[![codecov](https://codecov.io/gh/hugegraph/hugegraph-loader/branch/master/graph/badge.svg)](https://codecov.io/gh/hugegraph/hugegraph-loader) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.baidu.hugegraph/hugegraph-loader/badge.svg)](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-loader) + +`hugegraph-toolchains` is the integration of a series of utilities for [HugeGraph](https://github.com/hugegraph/hugegraph), it includes 4 main modules. + +## Modules + +- [hugegraph-loader](./hugegraph-loader): Loading datasets into the HugeGraph from multiple data sources. +- [hugegraph-hubble](./hugegraph-hubble): Online HugeGraph management and analysis dashboard (Include: data loading, schema management, graph traverser and display) +- [hugegraph-tools](./hugegraph-tools): Command line tool for deploying, managing and backing up/restoring graphs from HugeGraph. +- [hugegraph-client](./hugegraph-client): A Java-written client for HugeGraph, providing RESTful graph APIs for schema/gremlin/variables and traversals etc. + +## Doc + +The [project homepage](https://hugegraph.github.io/hugegraph-doc/) contains more information about `hugegraph-toolchains`. + +## License + +hugegraph-toolchains is licensed under `Apache 2.0` License. diff --git a/hugegraph-client/README.md b/hugegraph-client/README.md index 21a752a96..7fb17995b 100644 --- a/hugegraph-client/README.md +++ b/hugegraph-client/README.md @@ -15,5 +15,9 @@ hugegraph-client is a Java-written client of [HugeGraph](https://github.com/huge - RESTful Traversals, shortest path, k-out, k-neighbor, paths and crosspoints etc. - Variables, CRUD of variables +## Doc + +The [client homepage](https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-client.html) contains more information about it. + ## Licence The same as HugeGraph, hugegraph-client is also licensed under Apache 2.0 License. diff --git a/hugegraph-hubble/README.md b/hugegraph-hubble/README.md index bb58252de..69ce55ceb 100644 --- a/hugegraph-hubble/README.md +++ b/hugegraph-hubble/README.md @@ -11,11 +11,11 @@ hugegraph-hubble is a graph management and analysis platform that provides featu - Graph connection management, supporting to easily switch graph to operate - Graph data load, supporting to load large amounts of data from files into hugegraph-server - Schema management, supporting to easily perform schema manipulation and display -- graph analysis and graphical display, supporting to build query via gremlin or algorithms with a little effort then will get cool graphical results +- Graph analysis and graphical display, supporting to build query via the gremlin or algorithms with a little effort then will get cool graphical results -## Learn More +## Doc -[The project homepage](https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-hubble.html) contains more information about hugegraph-hubble. +[The hubble homepage](https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-hubble.html) contains more information about it. ## License diff --git a/hugegraph-loader/README.md b/hugegraph-loader/README.md index bd9e8fdc4..4196f1f5d 100644 --- a/hugegraph-loader/README.md +++ b/hugegraph-loader/README.md @@ -34,9 +34,9 @@ To build with default tests: mvn clean install ``` -## Learn More +## Doc -The [project homepage](https://hugegraph.github.io/hugegraph-doc/) contains more information about hugegraph-loader. +The [loader homepage](https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-loader.html) contains more information about it. ## License diff --git a/hugegraph-tools/README.md b/hugegraph-tools/README.md index 723e8a7e0..a5b348814 100644 --- a/hugegraph-tools/README.md +++ b/hugegraph-tools/README.md @@ -10,7 +10,7 @@ HugeGraph-Tools is a customizable command line utility for deploying, managing a ## Learn More -The [project homepage](https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-tools.html) contains more information about HugeGraph-Tools. +The [tools homepage](https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-tools.html) contains more information about it. ## License From fff65be03e09fe0b72cf1b8a161a78c326a59a86 Mon Sep 17 00:00:00 2001 From: imbajin <17706099+imbajin@users.noreply.github.com> Date: Fri, 15 Apr 2022 16:25:46 +0800 Subject: [PATCH 2/2] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dadc5776a..dafcd0798 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ -# hugegraph-toolchains +# hugegraph-toolchain [![License](https://img.shields.io/badge/license-Apache%202-0E78BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) [![Build Status](https://github.com/hugegraph/hugegraph-loader/actions/workflows/ci.yml/badge.svg)](https://github.com/hugegraph/hugegraph-loader/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/hugegraph/hugegraph-loader/branch/master/graph/badge.svg)](https://codecov.io/gh/hugegraph/hugegraph-loader) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.baidu.hugegraph/hugegraph-loader/badge.svg)](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-loader) -`hugegraph-toolchains` is the integration of a series of utilities for [HugeGraph](https://github.com/hugegraph/hugegraph), it includes 4 main modules. +`hugegraph-toolchain` is the integration project of a series of utilities for [HugeGraph](https://github.com/hugegraph/hugegraph), it includes 4 main modules. ## Modules - [hugegraph-loader](./hugegraph-loader): Loading datasets into the HugeGraph from multiple data sources. - [hugegraph-hubble](./hugegraph-hubble): Online HugeGraph management and analysis dashboard (Include: data loading, schema management, graph traverser and display) -- [hugegraph-tools](./hugegraph-tools): Command line tool for deploying, managing and backing up/restoring graphs from HugeGraph. -- [hugegraph-client](./hugegraph-client): A Java-written client for HugeGraph, providing RESTful graph APIs for schema/gremlin/variables and traversals etc. +- [hugegraph-tools](./hugegraph-tools): Command line tool for deploying, managing and backing-up/restoring graphs from HugeGraph. +- [hugegraph-client](./hugegraph-client): A Java-written client for HugeGraph, providing `RESTful` APIs for accessing graph vertex/edge/schema/gremlin/variables and traversals etc. ## Doc -The [project homepage](https://hugegraph.github.io/hugegraph-doc/) contains more information about `hugegraph-toolchains`. +The [project homepage](https://hugegraph.github.io/hugegraph-doc/) contains more information about `hugegraph-toolchain`. ## License -hugegraph-toolchains is licensed under `Apache 2.0` License. +hugegraph-toolchain is licensed under `Apache 2.0` License.