Merge pull request #1234 from virtualtam/lint

[github/shaarli/Shaarli.git] / plugins / wallabag / README.md

diff --git a/plugins/wallabag/README.md b/plugins/wallabag/README.md
index 08e0d44a0921e7af96b1dd3e3ee883812cd4f8bd..ea21a51925f33de0986a28550a167559e1406043 100644 (file)
--- a/plugins/wallabag/README.md
+++ b/plugins/wallabag/README.md
@@ -2,28 +2,36 @@
 
 For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/).
 
-### Installation/configuration
-Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.  
+### Installation
+
+Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.
 The directory structure should look like:
 
-```
+```bash
 └── tpl
     └── plugins
-        └── wallabag
-            ├── README.md
-            ├── wallabag.html
-            └── wallabag.png
+        └── wallabag
+            ├── README.md
+            ├── wallabag.html
+            ├── wallabag.meta
+            ├── wallabag.php
+            ├── wallabag.php
+            └── WallabagInstance.php
 ```
 
-To enable the plugin, add `'wallabag'` to your list of enabled plugins in `data/options.php` (`PLUGINS` array)
-. This should look like:
+To enable the plugin, you can either:
 
-```
-$GLOBALS['config']['PLUGINS'] = array('qrcode', 'any_other_plugin', 'wallabag')
-```
+  * enable it in the plugins administration page (`?do=pluginadmin`). 
+  * add `wallabag` to your list of enabled plugins in `data/config.json.php` (`general.enabled_plugins` section).
 
-Then, set the `WALLABAG_URL` variable in `data/options.php` pointing to your wallabag URL. Example:
+### Configuration
 
-```
-$GLOBALS['config']['WALLABAG_URL'] = 'http://demo.wallabag.org' ; //Base URL of your wallabag installation
-```
\ No newline at end of file
+Go to the plugin administration page, and edit the following settings (with the plugin enabled).
+
+**WALLABAG_URL**: *Wallabag instance URL*
+Example value: `http://v2.wallabag.org`
+
+**WALLABAG_VERSION**: *Wallabag version*
+Value: either `1` (for 1.x) or `2` (for 2.x)
+
+> Note: these settings can also be set in `data/config.json.php`, in the plugins section.