aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 2d4cefc42cf1b8147eab5c3690afb3299c36248b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
### Do not use this rust code.

This is not a complete implementation of WireGuard. If you're interested in using WireGuard, use the implementation for Linux [found here](https://git.zx2c4.com/WireGuard/) and described on the [main wireguard website](https://www.wireguard.io/). There is no group of users that should be using the code in this repository here under any circumstances at the moment, not even beta testers or dare devils. It simply isn't complete. However, if you're interested in assisting with the Rust development of WireGuard and contributing to this repository, by all means dig in and help out. But users: stay far away, at least for now.

# WireGuard.rs
[![Build Status](https://travis-ci.org/WireGuard/wireguard-rs.svg)](https://travis-ci.org/WireGuard/wireguard-rs) [![Coverage Status](https://coveralls.io/repos/github/WireGuard/wireguard-rs/badge.svg)](https://coveralls.io/github/WireGuard/wireguard-rs?branch=master) [![License GPL2](https://img.shields.io/badge/license-GPL_2-blue.svg)](https://github.com/WireGuard/wireguard-rs/blob/master/LICENSE)
## Fast, modern and secure VPN tunnel
Target of this project is to have a user space Rust implementation of WireGuard.

This implementation is currently _work in progress_ and is notable to work in the intended behavior.

## Development workflow
Actually the main repository is located at [git.zx2c4.com/wireguard-rs](https://git.zx2c4.com/wireguard-rs) whereas the
main repository maintainer is [Sascha Grunert](https://github.com/saschagrunert). This also means that the usage of the
GitHub issue and pull request mechanisms **are possible to use** whereas the contribution results are mirrored back to
the original repository.