summaryrefslogtreecommitdiff
path: root/extensions/Spoilers/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'extensions/Spoilers/README.md')
-rw-r--r--extensions/Spoilers/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/extensions/Spoilers/README.md b/extensions/Spoilers/README.md
new file mode 100644
index 0000000..f4b7826
--- /dev/null
+++ b/extensions/Spoilers/README.md
@@ -0,0 +1,21 @@
+Spoilers
+========
+
+Mediawiki extension that allows for spoiler tags that will hide a block of text. The spoiler button's show/hide message can be customized for each set.
+
+Installation
+------------
+To install this extension, add the follwoing lines to the end of the LocalSettings.php file:
+```
+//Spoilers
+require("$IP/extensions/Spoilers/Spoilers.php");
+```
+
+Usage Example
+---------------------
+```
+<spoiler hide="hide_message">spoiler_text</spoiler>
+<spoiler show="show_message">spoiler_text</spoiler>
+<spoiler show="show_message" hide="hide_message">spoiler_text</spoiler>
+<spoiler>spoiler_text</spoiler>
+```