From 938d9cce77ed5098dd69643795cb4014f3688b35 Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Tue, 22 Dec 2015 10:20:27 +0100
Subject: Wallabag plugin improvement

  * Fixes a bug where URL weren't properly encoded.
  * Adds Wallabag V2 support.
  * Adds a URL function to handle trailing slash.
  * UT.
  * README updated.
---
 plugins/wallabag/README.md | 25 +++++++++++++++++++------
 1 file changed, 19 insertions(+), 6 deletions(-)

(limited to 'plugins/wallabag/README.md')

diff --git a/plugins/wallabag/README.md b/plugins/wallabag/README.md
index 08e0d44a..5bc35be1 100644
--- a/plugins/wallabag/README.md
+++ b/plugins/wallabag/README.md
@@ -2,7 +2,8 @@
 
 For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/).
 
-### Installation/configuration
+### Installation
+
 Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.  
 The directory structure should look like:
 
@@ -11,19 +12,31 @@ The directory structure should look like:
     └── plugins
         └── wallabag
             ├── README.md
+            ├── config.php.dist
             ├── wallabag.html
+            ├── wallabag.php
             └── wallabag.png
 ```
 
-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, add `'wallabag'` to your list of enabled plugins in `data/options.php` (`PLUGINS` array).
+This should look like:
 
 ```
 $GLOBALS['config']['PLUGINS'] = array('qrcode', 'any_other_plugin', 'wallabag')
 ```
 
-Then, set the `WALLABAG_URL` variable in `data/options.php` pointing to your wallabag URL. Example:
+### Configuration
+
+Copy `config.php.dist` into `config.php` and setup your instance.
 
+*Wallabag instance URL*
 ```
-$GLOBALS['config']['WALLABAG_URL'] = 'http://demo.wallabag.org' ; //Base URL of your wallabag installation
-```
\ No newline at end of file
+$GLOBALS['config']['WALLABAG_URL'] = 'http://v2.wallabag.org' ;
+```
+
+*Wallabag version*: either `1` (for 1.x) or `2` (for 2.x)
+```
+$GLOBALS['config']['WALLABAG_VERSION'] = 2;
+```
+
+> Note: these settings can also be set in `data/config.php`.
\ No newline at end of file
-- 
cgit v1.2.3