From 5cdc2c978ace069c18afc37f24e007cafe4784df Mon Sep 17 00:00:00 2001 From: Robin Ward Date: Fri, 11 Mar 2016 15:58:33 -0500 Subject: [PATCH] Added a README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..35dcf97 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +### discourse-staff-notes + +This plugin gives staff members the ability to attach notes to users. + +Whenever the user posts, a little note icon will appear beside their name if they have +any staff notes. Clicking on it will reveal the notes other staff members have left. + +## Installation + +Follow our [Install a Plugin](https://meta.discourse.org/t/install-a-plugin/19157) howto, using +`git clone https://github.com/discourse/discourse-staff-notes.git` as the plugin command. + +Once you've installed it, review the settings under admin and then enable +`tagging_enabled`. + +## Issues + +If you have issues or suggestions for the plugin, please bring them up on [Discourse Meta](https://meta.discourse.org). + +## License + +MIT