Skip to content

Commit

Permalink
Resolve #90 (#91)
Browse files Browse the repository at this point in the history
* addres #90

Signed-off-by: jonathan-m-hamilton <jonathan.m.hamilton@accenture.com>

* addres #90 pt2

Signed-off-by: jonathan-m-hamilton <jonathan.m.hamilton@accenture.com>
  • Loading branch information
jonathan-m-hamilton authored and juraj-durech committed Nov 10, 2019
1 parent aec3dfc commit 284bf0e
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
* @tkuhrt @jonathan-m-hamilton @petermetz @sownak @juraj-durech
* @tkuhrt @jonathan-m-hamilton @sownak @juraj-durech

49 changes: 39 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
# Lab Name
Blockchain Automation Framework
# Blockchain Automation Framework

# Short Description
- [Short Description](#short-description)
- [Scope of Lab](#scope-of-lab)
- [Documentation](#documentation)
- [Hyperledger Fabric](#hyperledger-fabric)
- [Corda](#corda)
- [Contact](#contact)
- [Contributing](#contributing)
- [Initial Committers](#initial-committers)
- [Sponsor](#sponsor)

## Short Description
An automation framework for rapidly and consistently deploying production-ready DLT platforms

# Scope of Lab
## Scope of Lab
Blockchain Automation Framework delivers an automation framework for rapidly and consistently deploying production-ready DLT platforms to cloud infrastructure.

![What is Blockchain Automation Framework?](./docs/images/blockchain-automation-framework-overview.png "What is Blockchain Automation Framework?")
Expand All @@ -13,25 +22,45 @@ Blockchain Automation Framework makes use of Ansible, Helm, and Kubernetes to de

Blockchain Automation Framework initially supports Hyperledger Fabric and Corda. It is the intention to add support for Hyperledger Sawtooth, Hyperledger Indy and Quorum. Other DLT platforms can easily be added.

## Documentation
### Documentation
Detailed operator and developer documentation is available at [our ReadTheDocs site](https://blockchain-automation-framework.readthedocs.io/en/latest/index.html).

The documentation can also be built locally be following instructions in the `docs` folder.

## Hyperledger Fabric
### Hyperledger Fabric
For Hyperledger Fabric, we use the official Docker containers provided by that project. A number of different Ansible scripts will allow you to either create a new network (across clouds) or join an existing network.

![Blockchain Automation Framework - Fabric](./docs/images/blockchain-automation-framework-fabric.png "Blockchain Automation Framework for Hyperledger Fabric")

## Corda
### Corda
For Corda, we build Docker containers from the Corda source. A number of different Ansible scripts will allow you to either create a new network (across clouds) or join an existing network.

![Blockchain Automation Framework - Corda](./docs/images/blockchain-automation-framework-corda.png "Blockchain Automation Framework for Corda")

# Initial Committers
## Contact
We welcome your questions & feedback on our [Rocketchat channel](https://chat.hyperledger.org/channel/blockchain-automation-framework).

## Contributing
We welcome contributions to BAF in many forms, and there’s always plenty to do!

First things first, please review the [Hyperledger Code of Conduct](https://wiki.hyperledger.org/display/HYP/Hyperledger+Code+of+Conduct) before participating.

There are many ways to contibute to BAF, both as a user and as a developer.

As a user, this can inlcude:
* [Making Feature/Enhancement Proposals](https://github.com/hyperledger-labs/blockchain-automation-framework/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)
* [Reporting bugs](https://github.com/hyperledger-labs/blockchain-automation-framework/issues/new?assignees=&labels=bug&template=bug_report.md&title=)

As a developer:
* if you only have a little time, consider picking up a [“help-wanted”](https://github.com/hyperledger-labs/blockchain-automation-framework/labels/help%20wanted) or ["good-first-issue"](https://github.com/hyperledger-labs/blockchain-automation-framework/labels/good%20first%20issue) task
* If you can commit to full-time development, then please contact us on our [Rocketchat channel](https://chat.hyperledger.org/channel/blockchain-automation-framework) to work through logistics


## Initial Committers
- [tkuhrt](https://github.com/tkuhrt)
- [jonathan-m-hamilton](https://github.com/jonathan-m-hamilton)
- [petermetz](https://github.com/petermetz)
- [sownak](https://github.com/sownak)


# Sponsor
## Sponsor
Mark Wagner (Github: [n1zyz](https://github.com/n1zyz), email: [mwagner@redhat.com](mailto:mwagner@redhat.com)) - TSC Member

0 comments on commit 284bf0e

Please sign in to comment.