From e157ff0dce5736223cf2d54b0978794821a5b29f Mon Sep 17 00:00:00 2001 From: Herbert Reiter <4941275-moasda@users.noreply.gitlab.com> Date: Thu, 2 Jan 2020 17:01:44 +0100 Subject: [PATCH] Update readme --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 002a8fe..f0ae19e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ # MoasdaWiki App -App to synchronize data from MoasdaWiki Server \ No newline at end of file +## Description + +MoasdaWiki App is an extension of the MoasdaWiki Server to have a copy of +your Wiki content on your mobile device. + +To download the app see https://moasdawiki.net/. + +## Features + +- Synchronizes the data from a MoasdaWiki Server instance. +- Data privacy: No cloud connection established, directly connects to the server inside your private network. +- Fast and powerful full text search, supports regular expressions. +- Content cannot be modified within the app as it is no fun to type Wiki syntax on the mobile device, + changes have to be done via the MoasdaWiki Server. +- Calendar integration, shows birthdays and events in the mobile calendar (German version only). + +## Synchronize content with a MoasdaWiki Server + +1. Ensure to have a MoasdaWiki Server instance running on a computer in your LAN. +2. Install and open the MoasdaWiki App. +3. Click on menu button (⋮) in the upper right corner → Settings. +4. Enter host name of the server instance, e.g. `192.168.1.101`. +5. Enter port of the server instance, usually `11080` (see config file `config.txt`). +6. Click on "Connect to Server" button. +7. In the status section you should see the connection status "Needs authorization at server". +8. On server side open the Wiki page in a browser, click on "Help" and "Synchronization". +9. You can see a list of devices and synchronization sessions. Check the device name and click on "Grant". +10. Back in the app click on the button "Synchronize now". + Now you should have all the server content also in the app. + +## Support + +If you have questions or any problems you can contact me via [support@moasdawiki.net](). + +## License + +MoasdaWiki server is licensed under the GPL 3 license - see the LICENSE file for details. + +Copyright (C) Herbert Reiter