mirror of
https://github.com/oceanprotocol/barge.git
synced 2024-12-02 05:57:21 +01:00
updated readme
This commit is contained in:
parent
080335ba72
commit
71e8b0dc3d
65
README.md
65
README.md
@ -1 +1,64 @@
|
||||
# docker-images
|
||||
[![banner](doc/img/repo-banner@2x.png)](https://oceanprotocol.com)
|
||||
|
||||
<h1 align="center">docker-images</h1>
|
||||
|
||||
> 💧 Integration of TCRs, CPM and Ocean Tokens in Solidity
|
||||
> [oceanprotocol.com](https://oceanprotocol.com)
|
||||
|
||||
[![Build Status](https://travis-ci.com/oceanprotocol/keeper-contracts.svg?token=soMi2nNfCZq19zS1Rx4i&branch=master)](https://travis-ci.com/oceanprotocol/keeper-contracts)
|
||||
[![js ascribe](https://img.shields.io/badge/js-ascribe-39BA91.svg)](https://github.com/ascribe/javascript)
|
||||
|
||||
Ocean Keeper implementation where we put the following modules together:
|
||||
|
||||
* **TCRs**: users create challenges and resolve them through voting to maintain registries;
|
||||
* **Ocean Tokens**: the intrinsic tokens circulated inside Ocean network, which is used in the voting of TCRs;
|
||||
* **Marketplace**: the core marketplace where people can transact with each other with Ocean tokens.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Get Started](#get-started)
|
||||
- [Docker](#docker)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
---
|
||||
|
||||
## Get Started
|
||||
|
||||
For local development you can use Docker.
|
||||
|
||||
### Docker
|
||||
|
||||
The most simple way to get started is with Docker compose:
|
||||
|
||||
```bash
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
This will give you a local instance of ocean protocol.
|
||||
|
||||
## Contributing
|
||||
|
||||
We use GitHub as a means for maintaining and tracking issues and source code development.
|
||||
|
||||
If you would like to contribute, please fork this repository, do work in a feature branch, and finally open a pull request for maintainers to review your changes.
|
||||
|
||||
Ocean Protocol uses [C4 Standard process](https://github.com/unprotocols/rfc/blob/master/1/README.md) to manage changes in the source code. Find here more details about [Ocean C4 OEP](https://github.com/oceanprotocol/OEPs/tree/master/1).
|
||||
|
||||
## License
|
||||
|
||||
```
|
||||
Copyright 2018 Ocean Protocol Foundation
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user