From 4752fedc5c23a080937fe7566d25035bb2e4d972 Mon Sep 17 00:00:00 2001
From: Mal <=>
Date: Wed, 19 Aug 2020 14:21:35 +0200
Subject: [PATCH] Readme added

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4bd4534
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Ringfinger
+A restfull keyring API with web UI to share your jabber fingerprints with the people you want.
+
+Create an account, store your jabber fingerprints and share it with your friends. There is no need to type in your 64 chars long fingerprint for each of your friends. Just enter it once and decide which people you want to share your keyring with.
+
+# Setup
+Clone or copy the ringfinger folder to the location folder of your webserver. Move into the ringfinger folder an generate the cache:
+> make build
+
+## Webserver configuration
+Despite your basic setup with PHP and MySQL/MariaDB your webserver has to to rewrite all requests that access the path `/ringfinger/api/v1/...` to `/ringfinger/api/v1/index.php` to make the API working.
+
+### NGINX 
+Add the following line to your nginx.conf or to a separate file that will be included by the nginx.conf:
+
+> rewrite /ringfinger/api/v1/.* /ringfinger/api/v1/index.php;
+
+**Also make sure you deny the access to /ringfinger/data for all!**
+