From bcb77d979d817e1e609adb4d007bbbcc3f61efbd Mon Sep 17 00:00:00 2001
From: Tom van der Lee <tom@vanderlee.io>
Date: Thu, 30 Dec 2021 09:51:00 +0100
Subject: Prepare for github

---
 README.rst | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.rst

(limited to 'README.rst')

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..16538d9
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,30 @@
+===========
+TTUN Client
+===========
+
+|Deploy|
+
+.. |Deploy| image:: https://github.com/tomvanderlee/ttun-client/actions/workflows/python-publish.yml/badge.svg
+   :target: https://github.com/tomvanderlee/ttun-client/actions/workflows/python-publish.yml
+
+Expose a localport via you selfhosted `TTUN Server <https://github.com/tomvanderlee/ttun-server>`_
+
+Installing
+----------
+
+::
+
+    pip install ttun
+
+Developing
+----------
+
+1. Create and activate a python 3.10 virtual environment
+
+2. Install requirements::
+
+    pip install -r requirements.txt
+
+3. Run::
+
+    python -m ttun
-- 
cgit v1.2.3