Readme updated

This commit is contained in:
Mal 2020-08-24 22:46:24 +02:00
parent ef7f7c4b4a
commit 46fc2c978f
2 changed files with 10 additions and 4 deletions

View File

@ -4,7 +4,7 @@ repair:
setup:
php backend/scripts/setup.php
build:
cache:
php backend/scripts/generate.php
clean:

View File

@ -1,8 +1,14 @@
# Ringfinger
A restfull keyring API with web UI to share your jabber fingerprints with the people you want.
A restfull keyring API with web UI to share your OMEMO fingerprints for jabber with the people you like.
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.
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!