diff --git a/README.md b/README.md index 5dfc4a96..1f090cf6 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ ![Cello](docs/imgs/logo.png) -[![Build Status](https://travis-ci.org/yeasy/cello.svg?branch=dev)](https://travis-ci.org/yeasy/cello) +**Note:** This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/cello) repository, +where active development is ongoing. Issue tracking is handled in [Jira](https://jira.hyperledger.org/secure/RapidBoard.jspa?rapidView=111) + +## 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). Platform to provide Blockchain as a Service! -Using Cello, we can +Using Cello, we can * Provision customizable Blockchains instantly, e.g., a 6-node chain using PBFT consensus. -* Maintain a pool of running blockchains healthy with no manual operations. +* Maintain a pool of running blockchains healthy with no manual operations. * Check the system status, scale the chain numbers, change resources... through a dashboard. ![Typical Scenario](docs/imgs/scenario.png) @@ -34,23 +39,14 @@ You can also find more [scenarios](docs/scenario.md). * [Production Configuration](docs/production_config.md) ### Development Docs +* [How to contribute](docs/CONTRIBUTING.md) +* We're following [pep8 style guide](https://www.python.org/dev/peps/pep-0008/), [Coding Style](docs/code_style.md) * [Architecture Design](docs/arch.md) * [Database Model](docs/db.md) * [API](api/restserver_v2.md) -* [How to contribute](docs/CONTRIBUTING.md) - -## TODO -* restserver: update api definitions yml files. -* dashboard: support auto state fresh based on websocket. -* dashboard: support return code checking in response. -* dashboard: support user page. -* engine: support advanced scheduling. -* engine: support more-efficient fill-up. -* engine: enhance the robustness for chain operations. -* engine: support membersrvc option. ## Why named Cello? Can u find anyone better at playing chains? :) -## Author -Designed and maintained by [Baohua Yang](https://yeasy.github.com). +## License +The Hyperledger Project uses the [Apache License Version 2.0](LICENSE) software license. \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 03f3bb4d..6fe1a761 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -8,7 +8,7 @@ Before taking actions, we highly recommend reading the [docs](../README.md). We now have two channels for bug and questions: -* [Jira](https://jira.hyperledger.org/projects/CE/issues): report bug issues, create to-do tasks. +* [Jira](https://jira.hyperledger.org/secure/RapidBoard.jspa?rapidView=111): report bug issues, create to-do tasks. * [Slack](https://hyperledgerproject.slack.com/archives/cello): technical discussions and questions. Jira tasks with `To Do` status are available for picking. If you want to handle one, assign it to yourself, and update the status to `In Progress`. Remember to mark it to `Done` when the patch is merged.