PLUGIN wallabag

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

diff --git a/plugins/wallabag/README.md b/plugins/wallabag/README.md
new file mode 100644 (file)
index 0000000..08e0d44
--- /dev/null
+++ b/plugins/wallabag/README.md
@@ -0,0 +1,29 @@
+## Save to Wallabag plugin for Shaarli
+
+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.  
+The directory structure should look like:
+
+```
+└── tpl
+    └── plugins
+        └── wallabag
+            ├── README.md
+            ├── wallabag.html
+            └── wallabag.png
+```
+
+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:
+
+```
+$GLOBALS['config']['WALLABAG_URL'] = 'http://demo.wallabag.org' ; //Base URL of your wallabag installation
+```
\ No newline at end of file