From 46fc2c978f87d7970585e776492cc860d23ee9e6 Mon Sep 17 00:00:00 2001 From: Mal <=> Date: Mon, 24 Aug 2020 22:46:24 +0200 Subject: [PATCH] Readme updated --- Makefile | 2 +- README.md | 12 +++++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 5d91324..8025026 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ repair: setup: php backend/scripts/setup.php -build: +cache: php backend/scripts/generate.php clean: diff --git a/README.md b/README.md index 16e353a..1af3c22 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ # 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. +A restfull keyring API with web UI to share your OMEMO fingerprints for jabber with the people you like. +Create an account, store your OMEMO 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. + +# Requirements +* A webserver (Nginx, Apache, etc.) +* PHP 7.4 (with php-fpm configured) +* MySQL/MariaDB +* qrencode + # Setup Before you start setting up make sure you have an empty MySQL database created. You also need a database user that has full access to the newly created database!