Files
nym/README.md
T
Dave Hrycyszyn 1d2481e558 whitespace
2020-01-13 18:26:45 +00:00

20 lines
900 B
Markdown

## The Nym Privacy Platform
This repository contains the full Nym platform, written in Rust.
The platform is composed of multiple Rust crates. Top-level crates include:
* client - an executable crate which you can use for interacting with Nym nodes
* mixnode - an executable mixnode crate
* sfw-provider - an executable store-and-forward provider crate. The provider acts sort of like a mailbox for mixnet messages.
[![Build Status](https://travis-ci.com/nymtech/nym.svg?branch=develop)](https://travis-ci.com/nymtech/nym)
### Building
Platform build instructions are available on [our docs site](https://nymtech.net/docs/mixnet/installation/).
### Developing
There's a `.env.sample-dev` file provided which you can rename to `.env` if you want convenient logging, backtrace, or other environment variables pre-set. The `.env` file is ignored so you don't need to worry about checking it in.