Merge remote-tracking branch 'gnuio/master' into nightly

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

diff --git a/plugins/Oembed/README b/plugins/Oembed/README
index be8c09f7a6833b6b1b39916b8593401cf605d2e5..b5e1aeae1ffe138954531ddd220147f6da13ba9c 100644 (file)
--- a/plugins/Oembed/README
+++ b/plugins/Oembed/README
@@ -1 +1,29 @@
-It's really called oEmbed.
+The Oembed plugin for using and representing oEmbed data.
+
+See: http://www.oembed.com/
+
+Installation
+============
+This plugin is enabled by default
+
+Settings
+========
+width: Maximum width of the thumbnail in pixels.
+height: Maximum height of the thumbnail in pixels.
+show_html: Whether to show HTML oEmbed data.
+domain_whitelist: Array of regular expressions. Always escape your dots and end your strings.
+check_whitelist: Whether to check the domain_whitelist.
+
+Example
+=======
+$config['thumbnail']['width'] = 42;
+$config['thumbnail']['height'] = 42;
+$config['attachments']['show_html'] = true;
+addPlugin('Oembed', array(
+    'domain_whitelist' => array(
+        '^i\d*\.ytimg\.com$' => 'YouTube',
+        '^i\d*\.vimeocdn\.com$' => 'Vimeo'
+    ),
+    'check_whitelist' => true
+));
+