README.md
1# Progressive Web App Plugin for DokuWiki
2
3Add an offline mode to DokuWiki
4
5## Installation Instructions
6
7❗❗❗
8
9**In addition to the usual plugin installation you have to symlink the file `sw.js` from your wiki's root directory!!!**
10
11❗❗❗
12
13## Usual README
14
15
16All documentation for this plugin can be found at
17https://dokuwiki.org/plugin:pwaoffline
18
19If you install this plugin manually, make sure it is installed in
20lib/plugins/pwaoffline/ - if the folder is called different it
21will not work!
22
23Please refer to http://www.dokuwiki.org/plugins for additional info
24on how to install plugins in DokuWiki.
25
26----
27Copyright (C) Michael Große <mic.grosse@googlemail.com>
28
29This program is free software; you can redistribute it and/or modify
30it under the terms of the GNU General Public License as published by
31the Free Software Foundation; version 2 of the License
32
33This program is distributed in the hope that it will be useful,
34but WITHOUT ANY WARRANTY; without even the implied warranty of
35MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36GNU General Public License for more details.
37
38See the LICENSING file for details
39