diff --git a/README.md b/README.md index 24ca0489c..88a56da23 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,31 @@ -![Cello](docs/imgs/logo.png) +**Note:** This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/cello) repository. Find more details at [Cello Wiki](https://wiki.hyperledger.org/projects/cello). -Cello is a blockchain provision and operational system, which helps provide Blockchain as a Service. +![Cello](docs/imgs/logo.png) -**Note:** This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/cello) repository. Find more details at [Cello Wiki](https://wiki.hyperledger.org/projects/cello). +Hyperledger Cello is a blockchain provision and operational system, which helps provide Blockchain as a Service. ## Introduction - -Using Cello, everyone can: +Using Cello, everyone can easily: * Provision customizable Blockchains instantly, e.g., a Hyperledger fabric network. * Maintain a pool of running blockchains atop of baremetals, vms, Docker Swarm and Kubernetes. -* Check the system status, scale the chain numbers, change resources... through a dashboard. +* Check the system status, adjust the chain numbers, scale resources... through a dashboard. -![Typical Scenario](docs/imgs/scenario.png) +A typical usage scenario is illustrated as: -Feel free to explore more [scenarios](docs/scenario.md). +![Typical Scenario](docs/imgs/scenario.png) ## Main Features +* Manage the lifecycle of blockchains, e.g., create/start/stop/delete/keep health automatically. +* Support customized (e.g., size, consensus) blockchains request, currently we mainly support [Hyperledger fabric](https://github.com/hyperledger/fabric). +* Support native Docker host, swarm or Kubernetes as the worker nodes. More supports on the way. +* Support heterogeneous architecture, e.g., X86, POWER and Z, from bare-metal servers to virtual machines. +* Extend with monitor, log, health and analytics features by employing additional components. + +## Documentation, Getting Started and Develop Guideline +For new users, it is highly recommended to read the [tutorial](docs/tutorial.md) or [index](docs/index.md) first. -* Manage the lifecycle of blockchains, e.g., create/delete/keep health automatically. -* Response nearly instantly, even with hundreds of chains, or nodes. -* Support customized (e.g., size, consensus) blockchains request, currently we support [hyperledger fabric](https://github.com/hyperledger/fabric). -* Support native Docker host or swarm host as the compute nodes, more supports on the way. -* Support heterogeneous architecture, e.g., Z, Power and X86, from bare-metal servers to virtual machines. -* Extend with monitor/log/health features by employing additional components. - -## Documentation - -For new users, it is highly recommended to read the [tutorial](docs/tutorial.md) first. - -### User Docs -* [Installation Steps](docs/installation.md) -* [Terminology List](docs/terminology.md) -* [Adoption Scenarios](docs/scenario.md) -* [Production Configuration](docs/production_config.md) - -### Development Docs -* [How to contribute](docs/CONTRIBUTING.md) -* [Architecture Design](docs/arch.md) -* [Database Model](docs/db.md) -* [API](api/restserver_v2.md) -* [Develop react js](docs/reactjs.md) -* [pep8 style guide](https://www.python.org/dev/peps/pep-0008/), [Coding Style](docs/code_style.md) +And feel free to visit the [online documentation](http://cello.readthedocs.io/en/latest/) for more information. ## Why named Cello? Can you find anyone better at playing chains? :) diff --git a/api/dashboard.yaml b/docs/api/dashboard.yaml similarity index 100% rename from api/dashboard.yaml rename to docs/api/dashboard.yaml diff --git a/api/restserver_v1.md b/docs/api/restserver_v1.md similarity index 100% rename from api/restserver_v1.md rename to docs/api/restserver_v1.md diff --git a/api/restserver_v1.yaml b/docs/api/restserver_v1.yaml similarity index 100% rename from api/restserver_v1.yaml rename to docs/api/restserver_v1.yaml diff --git a/api/restserver_v2.md b/docs/api/restserver_v2.md similarity index 100% rename from api/restserver_v2.md rename to docs/api/restserver_v2.md diff --git a/docs/index.md b/docs/index.md index 7c8c55346..73bd2c1d6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,52 +1,42 @@ -![Cello](docs/imgs/logo.png) +Welcome to Hyperledger Cello +=== -Cello is a blockchain provision and operational system, which helps provide Blockchain as a Service. +Hyperledger Cello is a blockchain provision and operational system, which helps provide Blockchain as a Service. -**Note:** This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/cello) repository. Find more details at [Cello Wiki](https://wiki.hyperledger.org/projects/cello). +Hyperledger Cello is designed with the following features: -## Introduction +* Manage the lifecycle of blockchains, e.g., create/start/stop/delete/keep health automatically. +* Support customized (e.g., size, consensus) blockchains request, currently we mainly support [Hyperledger fabric](https://github.com/hyperledger/fabric). +* Support native Docker host, swarm or Kubernetes as the worker nodes. More supports on the way. +* Support heterogeneous architecture, e.g., X86, POWER and Z, from bare-metal servers to virtual machines. +* Extend with monitor, log, health and analytics features by employing additional components. -Using Cello, everyone can: +Using Cello, every Blockchain application developer can: * Provision customizable Blockchains instantly, e.g., a Hyperledger fabric network. * Maintain a pool of running blockchains atop of baremetals, vms, Docker Swarm and Kubernetes. -* Check the system status, scale the chain numbers, change resources... through a dashboard. +* Check the system status, adjust the chain numbers, scale-out resources... through a dashboard. -![Typical Scenario](docs/imgs/scenario.png) +A typical usage scenario is illustrated as: -Feel free to explore more [scenarios](docs/scenario.md). +![Typical Scenario](imgs/scenario.png) -## Main Features - -* Manage the lifecycle of blockchains, e.g., create/delete/keep health automatically. -* Response nearly instantly, even with hundreds of chains, or nodes. -* Support customized (e.g., size, consensus) blockchains request, currently we support [hyperledger fabric](https://github.com/hyperledger/fabric). -* Support native Docker host or swarm host as the compute nodes, more supports on the way. -* Support heterogeneous architecture, e.g., Z, Power and X86, from bare-metal servers to virtual machines. -* Extend with monitor/log/health features by employing additional components. - -## Documentation +## Getting Started For new users, it is highly recommended to read the [tutorial](docs/tutorial.md) first. -### User Docs -* [Installation Steps](docs/installation.md) -* [Terminologies List](docs/terminology.md) -* [Adoption Scenarios](docs/scenario.md) -* [Production Configuration](docs/production_config.md) - -### Development Docs -* [How to contribute](docs/CONTRIBUTING.md) -* [Architecture Design](docs/arch.md) -* [Database Model](docs/db.md) -* [API](api/restserver_v2.md) -* [Develop react js](docs/reactjs.md) -* [pep8 style guide](https://www.python.org/dev/peps/pep-0008/), [Coding Style](docs/code_style.md) - -## Why named Cello? -Can you find anyone better at playing chains? :) - -## Incubation Notice -This project is a Hyperledger project in _Incubation_. It was proposed to the community and documented [here](https://docs.google.com/document/d/1E2i5GRqWsIag7KTxjQ_jQdDiWcuikv3KqXeuw7NaceM/edit), and was approved by [Hyperledger TSC at 2017-01-07](https://lists.hyperledger.org/pipermail/hyperledger-tsc/2017-January/000535.html). Information on what _Incubation_ entails can be found in the [Hyperledger Project Lifecycle document](https://goo.gl/4edNRc). +## Operational Guideline +* [Installation Steps](installation) +* [Terminologies List](terminology) +* [Adoption Scenarios](scenario) +* [Production Configuration](production_config) + +## Development Guideline +* [How to contribute](CONTRIBUTING) +* [Architecture Design](arch) +* [Database Model](db) +* [API](api/restserver_v2) +* [Develop react js](reactjs) +* [pep8 style guide](https://www.python.org/dev/peps/pep-0008/), [Coding Style](code_style) Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License.