diff options
Diffstat (limited to 'plugins/wallabag/README.md')
-rw-r--r-- | plugins/wallabag/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/plugins/wallabag/README.md b/plugins/wallabag/README.md new file mode 100644 index 00000000..08e0d44a --- /dev/null +++ b/plugins/wallabag/README.md | |||
@@ -0,0 +1,29 @@ | |||
1 | ## Save to Wallabag plugin for Shaarli | ||
2 | |||
3 | For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/). | ||
4 | |||
5 | ### Installation/configuration | ||
6 | Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there. | ||
7 | The directory structure should look like: | ||
8 | |||
9 | ``` | ||
10 | └── tpl | ||
11 | └── plugins | ||
12 | └── wallabag | ||
13 | ├── README.md | ||
14 | ├── wallabag.html | ||
15 | └── wallabag.png | ||
16 | ``` | ||
17 | |||
18 | To enable the plugin, add `'wallabag'` to your list of enabled plugins in `data/options.php` (`PLUGINS` array) | ||
19 | . This should look like: | ||
20 | |||
21 | ``` | ||
22 | $GLOBALS['config']['PLUGINS'] = array('qrcode', 'any_other_plugin', 'wallabag') | ||
23 | ``` | ||
24 | |||
25 | Then, set the `WALLABAG_URL` variable in `data/options.php` pointing to your wallabag URL. Example: | ||
26 | |||
27 | ``` | ||
28 | $GLOBALS['config']['WALLABAG_URL'] = 'http://demo.wallabag.org' ; //Base URL of your wallabag installation | ||
29 | ``` \ No newline at end of file | ||