summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--js/compact-boardlist.js22
1 files changed, 22 insertions, 0 deletions
diff --git a/js/compact-boardlist.js b/js/compact-boardlist.js
index 47fdf5ac..c707a797 100644
--- a/js/compact-boardlist.js
+++ b/js/compact-boardlist.js
@@ -1,3 +1,25 @@
+/*
+ * compact-boardlist.js
+ * https://github.com/vichan-devel/Tinyboard/blob/master/js/compact-boardlist.js
+ *
+ * Released under the MIT license
+ * Copyright (c) 2014 Marcin Ɓabanowski <marcin@6irc.net>
+ *
+ * Usage:
+ * $config['boards'] = array(
+ * "icon_vichan" => array('*'), # would refer to /static/icons/vichan.png
+ * "Regular" => array('b', 'cp', 'r+oc', 'id', 'waifu'),
+ * "Topical" => array('sci', "Offsite board name" => '//int.vichan.net/s/'),
+ * "fa_search" => array("search" => "/search.php") # would refer to a search
+ * # font-awesome icon
+ * )
+ *
+ * $config['additional_javascript'][] = 'js/jquery.min.js';
+ * $config['additional_javascript'][] = 'js/compact-boardlist.js';
+ * #$config['additional_javascript'][] = 'js/watch.js';
+ *
+ */
+
if (device_type == 'desktop') {
compact_boardlist = true;