gopkg.in/dedis/onet.v2@v2.0.0-20181115163211-c8f3724038a7/README.md (about) 1 [![Build Status](https://travis-ci.org/dedis/onet.svg?branch=master)](https://travis-ci.org/dedis/onet) 2 [![Go Report Card](https://goreportcard.com/badge/github.com/dedis/onet)](https://goreportcard.com/report/github.com/dedis/onet) 3 [![Coverage Status](https://coveralls.io/repos/github/dedis/onet/badge.svg)](https://coveralls.io/github/dedis/onet) 4 5 # The Cothority Network Library - ONet 6 7 The Overlay-network (ONet) is a library for simulation and deployment of 8 decentralized, distributed protocols. It offers an abstraction for tree-based 9 communications between thousands of nodes and is used both in research for 10 testing out new protocols and running simulations, as well as in production to 11 deploy those protocols as a service in a distributed manner. 12 13 ONet is developed by [DEDIS/EFPL](http://dedis.epfl.ch) as part of the 14 [Cothority](https://github.com/dedis/cothority) project that aims to deploy 15 a large number of conodes for distributed signing and related projects. 16 17 ## Documentation 18 19 - To run and use a conode, have a look at 20 [Cothority Node](https://github.com/dedis/cothority/wiki/Conode) 21 with examples of protocols, services and apps 22 - To start a new project by developing and integrating a new protocol, have a look at 23 the [Cothority Template](https://github.com/dedis/cothority_template/wiki) 24 - To participate as a core-developer, go to 25 [Cothority Network Library](https://github.com/dedis/onet/wiki) 26 27 ## Version 28 29 We have a development and a stable version. The `master`-branch in 30 `github.com/dedis/onet` is the development version that works but can have 31 incompatible changes. 32 33 The version at `gopkg.in/dedis/onet.v1` is stable and has no incompatible 34 changes. 35 36 Also have a look at https://github.com/dedis/onet/blob/master/CHANGELOG.md for 37 any incompatible changes. 38 39 ## License 40 41 All repositories for the cothority-project 42 ([ONet](https://github.com/dedis/onet), 43 [cothority](https://github.com/dedis/cothority), 44 [cothority_template](https://github.com/dedis/cothority_template)) 45 are double-licensed under a 46 GNU/AGPL 3.0 and a commercial license. If you want to have more information, 47 contact us at dedis@epfl.ch. 48 49 ## Contribution 50 51 If you want to contribute to Cothority-ONet, please have a look at 52 [CONTRIBUTION](https://github.com/dedis/onet/blob/master/CONTRIBUTION) for 53 licensing details. Once you are OK with those, you can have a look at our 54 coding-guidelines in 55 [Coding](https://github.com/dedis/Coding). In short, we use the github-issues 56 to communicate and pull-requests to do code-review. Travis makes sure that 57 everything goes smoothly. And we'd like to have good code-coverage. 58 59 # Contact 60 61 You can contact us at https://groups.google.com/forum/#!forum/cothority or 62 privately at dedis@epfl.ch.