summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Save <savetheinternet@tinyboard.org>2012-03-14 20:00:57 +1100
committerMichael Save <savetheinternet@tinyboard.org>2012-03-14 20:00:57 +1100
commitd47bfe019b52f11fff3c5149b36cd905d07832cd (patch)
treeb588f12cf89d5fff6d76021a57dcf302d461d091 /README.md
parent81663b7d86c97fc808df8b201868bcda90e319ce (diff)
readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29b..12b825eb 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,11 @@
+# Tinyboard Tools
+This repository is a collection of management scripts, javascript addons, stylesheets and miscellaneous tools for [Tinyboard](http://github.com/savetheinternet/Tinyboard).
+
+## Directories
+* ```tools/``` -- Command-line management scripts for Tinyboard. These should not be publicly executable.
+* ```stylesheets/``` -- Additional stylesheets for Tinyboard, mainly user contributions.
+* ```js/``` -- Useful Javascript addons for Tinyboard, such as "quick reply" and client-side "forced anonymous". Most of these can be included using ```$config['additional_javascript']```.
+
+
+## License
+The contents of this repository are licensed under the terms of [Tinyboard's license](https://github.com/savetheinternet/Tinyboard/blob/master/LICENSE.md) unless stated otherwise.