From 7ecbc34d174b0ba9c04c8e0933339389aeb1e974 Mon Sep 17 00:00:00 2001
From: Miguel Nogueira <miguel456@spacejewel-hosting.com>
Date: Tue, 11 Jun 2019 19:40:25 +0100
Subject: [PATCH] Add Readme and License. Testing ensues.

---
 LICENSE   |  8 ++++++++
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e4cc015
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,8 @@
+Copyright 2019 Miguel Nogueira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1d95880
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+#PyVPN
+## Suitable for RasperryPI3 Model B+
+
+
+### Error exit codes:
+
+```
+0: ran successfully
+1: no config file found
+2: missing options
+3: missing client name after options
+```
+
+### Usage
+
+``./pyvpn --create-client [clientname]``
+
+### Requirements
+
+This program requires the following libraries:
+
+``pexpect``
+
+``base64``
+
+Only ``pexpect`` needs to be installed. Run ``pip install pexpect`` to install it.
+
+### Compatibilty
+
+This script hasn't been tested for Windows use. It will, however, run in all distributions and RPI too.
+You need to have Python installed for this to work.
+
+
+### Installation
+
+Move the script to the scripts directory:
+
+``mv pyVPN.py /usr/local/bin/pyvpn``
+
+
+### Contributing
+
+All contributions are generally accepted! I'm grateful for any support and advice I might encounter.
+Thank you!
+
+
+### What it returns
+The program will return a base64 encoded string of the client config file, for ease of transport across other programs.
+However, you can clean your terminal and look for the file in the ```/root``` directory. 
+
+``/root/example.ovpn``
+
+### Licensing
+
+See ``LICENSE``
\ No newline at end of file