Commit 008776ff authored by Johannes Schwab's avatar Johannes Schwab

update README.md

parent 33d42f13
......@@ -2,8 +2,7 @@
OpenRecipes is a privacy friendly personal cook book.
Most notable feature is the possibility so synchronize your recipes between multiple devices.
The data is end-to-end encrypted between devices.
Most notable feature is the possibility so synchronize your recipes end-to-end encrypted between multiple devices.
Other features are:
......@@ -12,9 +11,13 @@ Other features are:
* Save and import recipes to/from file
* On Android: share recipes via other apps
The client currently runs at Android, Linux and Windows.
The client should run on all major platforms (Android, Linux and Windows are tested).
Out of the box the client works completely offline<sup>1</sup>, the server is only needed for synchronization.
There is a default server preconfigured, but can be replaced by a costume server in the settings.
For details about the synchronization protocol please see `doc/synchronization_protocol.md`.
The server only runs on Linux. It needs a mysql compatible database and is configured with an ini style file like this:
The server only runs on Linux.
It needs a mysql compatible database and is configured with an ini style file like this:
[general]
;number of jobs to run in the background (>=1) (optional, default: 2)
......@@ -68,5 +71,7 @@ E.g. to only build the server do something like
qmake
make
---
<sup>1</sup> On Windows, the client will check for updates on startup by fetching `https://api.openrecipes.jschwab.org/currentClientVersion.txt`.
Since there isn't any package manager on Windows, thats the only way to promote any updates.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment