Holochain-rust

Travis: Circle CI: Codecov: License:

This is the home of the Holochain Rust libraries.

This code is loosely based on the Golang prototype.

Code Status: Rust version is alpha. Not for production use. The code is guaranteed NOT secure. We will aggressively restructure code APIs and data chains until Beta.

Releases happen weekly.

Overview

Holochain-Rust Architectural Overview

Application Developer

Setup a development environment with the latest release to build Holochain applications:

https://developer.holochain.org/start.html

Core Developer

Setup a core development environment to work on Holochain itself:

Core Developer Setup

Documentation

API Reference

Auto generated documentation for all of the code written in Rust is published online, with different versions to match the releases here: https://developer.holochain.org/docs/api.

The Holochain Guidebook

There is a guide for understanding and developing with Holochain. It is published online, with different versions to match the releases here: https://developer.holochain.org/guide.

See instructions for how to contribute to the book at doc/holochain_101/src/how_to_contribute.md.

Contribute

Holochain is an open source project. We welcome all sorts of participation and are actively working on increasing surface area to accept it. Please see our contributing guidelines for our general practices and protocols on participating in the community, as well as specific expectations around things like code formatting, testing practices, continuous integration, etc.

Some helpful links:

• Chat with us on our Chat Server or Gitter

License

Copyright (C) 2017 - 2019, Holochain Foundation

This program is free software: you can redistribute it and/or modify it under the terms of the license p rovided in the LICENSE file (GPLv3). This program is distributed in the hope that it will be useful, bu t WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Note: We are considering other 'looser' licensing options (like MIT license) but at this stage are using GPL while we're getting the matter sorted out. See this article for some of our thinking on licensing for distributed application frameworks.