|
| 1 | +# Welcome to Baseline |
| 2 | + |
| 3 | +<div align="center"> |
| 4 | + <img src="docs/assets/baseline-logo/Web/examples/PNGs/horizontal/baselineHorizontal-Logo-FullColor.png" /> |
| 5 | + <p> |
| 6 | + Combining advances in cryptography, messaging, and blockchain to execute |
| 7 | + <br/> |
| 8 | + secure and private business processes via the public Ethereum Mainnet. |
| 9 | + </p> |
| 10 | + Read the full documentation <a href="https://radish.gitbook.io/docs/-LuE-E657uooMibsj9_Y/">here</a>. |
| 11 | + <p> |
| 12 | + <em>Join our <a href="https://communityinviter.com/apps/ethereum-baseline/join-us">Slack workspace</a> for Baseline news and updates!</em> |
| 13 | + </p> |
| 14 | + <br/> |
| 15 | +</div> |
| 16 | + |
| 17 | +__Baseline__ is an open source initiative with a large and growing team of supporting companies. The first code was donated by Ernst & Young and ConsenSys, with support from Microsoft, and is now receiving contributions from many other companies. The purpose of the project is to bring enterprises and complex business processes to the Ethereum Mainnet, while guarding the privacy constraints and needs of a typical group of enterprises. |
| 18 | + |
| 19 | +The __Baseline Protocol__ defines a series of steps to follow to privately and securely synchronize data inside two independent databases, using the Ethereum Mainnet as an auditable common frame of reference. This protocol implements best practices around data consistency and compartmentalization, and leverages public Ethereum for verifying execution of private transactions, contracts and tokens on the mainnet using ZKP (zkSnarks). The __Baseline Protocol__ is designed such that it can be extended and applied to any database/workflow. |
| 20 | + |
| 21 | +# Radish34 |
| 22 | + |
| 23 | +In order to demonstrate the __Baseline Protocol__, we needed a use-case. The use-case chosen was product procurement within a supply-chain, and the custom application built for this workflow is called __Radish34__. |
| 24 | + |
| 25 | +The __Baseline Protocol__ code is currently embedded inside the `/radish-api` directory, but we are in the process of moving that code into the `/baseline` directory to clearly distinguish the protocol from the use-case. Once this move is complete, `radish-api` will import `baseline` as a module, which will be the same process that other projects will need to follow to implement __Baseline__. |
| 26 | + |
| 27 | +To run the __Radish34__ application, follow the instructions in `/radish34/README.md`. |
| 28 | + |
| 29 | +# How to contribute? |
| 30 | + |
| 31 | +__Baseline__ is an open-source project that is actively seeking contributions from any willing participants. Here are some guidelines for people that would like to contribute to the project. |
| 32 | + |
| 33 | +## Submitting an issue |
| 34 | + |
| 35 | +To help us get a better understanding of the issue you've identified, follow the guidelines in one of our *Issue Templates*. |
| 36 | + |
| 37 | +## Submitting a pull request |
| 38 | + |
| 39 | +Follow these steps when submitting a pull request: |
| 40 | + |
| 41 | +1. Fork this repo into your GitHub account. Read more about forking a repo on Github [here](https://help.github.com/articles/fork-a-repo/). |
| 42 | +1. Create a new branch, based on the `master` branch, with a name that concisely describes what you’re working on (ex. `add-mysql`). |
| 43 | +1. Ensure that your changes do not cause any existing tests to fail. |
| 44 | +1. Submit a pull request against the `master` branch. |
| 45 | + |
| 46 | +# License |
| 47 | + |
| 48 | +All code in this repo is released under the CC0 1.0 Universal public domain dedication. For the full license text, refer to `license.md`. |
0 commit comments