Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: add README for toolchain #257

Merged
merged 2 commits into from
Apr 15, 2022
Merged

doc: add README for toolchain #257

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2efcd88
doc: add readme for toolchains
imbajin Apr 15, 2022
fff65be
Update README.md
imbajin Apr 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# hugegraph-toolchains
imbajin marked this conversation as resolved.
Show resolved Hide resolved

[![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.
imbajin marked this conversation as resolved.
Show resolved Hide resolved

## 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.
imbajin marked this conversation as resolved.
Show resolved Hide resolved
- [hugegraph-client](./hugegraph-client): A Java-written client for HugeGraph, providing RESTful graph APIs for schema/gremlin/variables and traversals etc.
imbajin marked this conversation as resolved.
Show resolved Hide resolved

## Doc

The [project homepage](https://hugegraph.github.io/hugegraph-doc/) contains more information about `hugegraph-toolchains`.
imbajin marked this conversation as resolved.
Show resolved Hide resolved

## License

hugegraph-toolchains is licensed under `Apache 2.0` License.
4 changes: 4 additions & 0 deletions hugegraph-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions hugegraph-hubble/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions hugegraph-loader/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion hugegraph-tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down