From 14771695c44676e0e222287bc0bf0c56fd229cd3 Mon Sep 17 00:00:00 2001
From: Sebastian Lohff <seba@someserver.de>
Date: Tue, 29 Sep 2020 22:18:38 +0200
Subject: [PATCH] Add README.md

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 setup.py  |  6 +++++-
 2 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d4578e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+Servefile
+=========
+
+Serve files from shell via a small HTTP server. The server redirects all HTTP
+requests to the file, so only IP and port must be given to another user to
+access the file. Its main purpose is to quickly send a file to users in your
+local network, independent of their current setup (OS/software). Besides that
+it also supports uploads, SSL, HTTP basic auth and directory listings.
+
+Features:
+ * serve single file
+ * serve a directory with directory index
+ * file upload via webinterface
+ * HTTPS with on the fly generated self signed SSL certificates
+ * HTTP basic authentication
+ * serving files/directories as on request generated tar files
+
+Install
+-------
+
+Via pip
+```shell
+pip install servefile
+```
+After installation either execute `servefile --help` or `python -m servefile --help`
+
+Standalone:
+If you don't have pip available just copy `servefile/servefile.py` onto the target machine, make it executable and you are ready to go.
+```shell
+$ wget https://raw.githubusercontent.com/sebageek/servefile/master/servefile/servefile.py -O servefile
+$ chmod +x servefile
+$ ./servefile --help
+```
diff --git a/setup.py b/setup.py
index 7fe811e..ab54bd4 100755
--- a/setup.py
+++ b/setup.py
@@ -2,10 +2,14 @@
 
 from setuptools import setup
 
+with open("README.md") as f:
+    long_description = f.read()
+
 setup(
     name='servefile',
     description='Serve files from shell via a small HTTP server',
-    long_description='Serve files from shell via a small HTTP server. The server redirects all HTTP requests to the file, so only IP and port must be given to another user to access the file. Its main purpose is to quickly send a file to users in your local network, independent of their current setup (OS/software). Beneath that it also supports uploads, SSL, HTTP basic auth and directory listings.',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     platforms='posix',
     version='0.4.4',
     license='GPLv3 or later',