aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eb88d0f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+### Do not use this 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
+Android 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.
+
+-------
+
+# Android Implementation of WireGuard
+
+This is a work in progress for implementing WireGuard for Android.
+
+## 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.