aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJake McGinty <me@jake.su>2017-12-22 14:01:48 -0600
committerJake McGinty <me@jake.su>2017-12-22 14:01:48 -0600
commit686bf9b0eeea22781bae19af76a84bab50ded541 (patch)
tree175756fcc2287be756fed5c71dcfe63ee053b486 /README.md
parentearly, early rough draft (diff)
downloadwireguard-rs-686bf9b0eeea22781bae19af76a84bab50ded541.tar.xz
wireguard-rs-686bf9b0eeea22781bae19af76a84bab50ded541.zip
add license and readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a0a5a9c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+### 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.com/). 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.
+
+-------
+
+# Rust Implementation of WireGuard
+
+This is a work in progress for implementing WireGuard in Rust.
+
+## License
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License version 2 as
+ published by the Free Software Foundation.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+
+