Merge branch 'fix-author-fallback' into 'nightly'

[quix0rs-gnu-social.git] / plugins / LinkPreview / README

diff --git a/plugins/LinkPreview/README b/plugins/LinkPreview/README
index a1b1a8730342e2a022d55645ecafd60e774df159..e15c67a1a35a0aae8da3c577534ebcca346b10ee 100644 (file)
--- a/plugins/LinkPreview/README
+++ b/plugins/LinkPreview/README
@@ -1 +1,23 @@
-Depends on the oEmbed plugin (Oembed)
+The LinkPreview plugin adds a UI for previewing thumbnails from links.
+
+Note: This plugin depends on the "Oembed" plugin.
+
+Installation
+============
+add "addPlugin('LinkPreview');"
+to the bottom of your config.php
+
+Settings
+========
+process_links: Whether to process links or not
+thumbwidth: The width of the link preview
+thumbheight: The height of the link preview
+
+Example
+=======
+addPlugin('Oembed'); // Dependency
+$config['attachments']['process_links'] = true;
+$config['attachments']['thumbwidth'] = 42;
+$config['attachments']['thumbheight'] = 42;
+addPlugin('LinkPreview');
+