1 files changed, 26 insertions, 0 deletions
diff --git a/mod/categories/readme.txt b/mod/categories/readme.txt
new file mode 100644
index 000000000..49241b2f4
--- /dev/null
+++ b/mod/categories/readme.txt
@@ -0,0 +1,26 @@
+Site-wide categories
+--------------------
+
+NOTES FOR PROGRAMMERS:
+
+If you're not a programmer, don't worry! All the main Elgg tools
+are already adapted to use categories, and a growing number of
+third party Elgg tools use it too.
+
+
+This plugin uses views and events hooks to allow you to easily add
+site-wide categories across Elgg tools.
+
+This is a two-line addition to any plugin.
+
+In your edit/create form:
+
+	echo elgg_view('categories', $vars);
+
+In your object view:
+
+	echo elgg_view('categories/view', $vars);
+	
+Note that in both cases, $vars['entity'] MUST be populated with
+the entity the categories apply to, if it exists. (i.e., there's
+no need for this on a create form.)
+\ No newline at end of file