Added a README

This commit is contained in:
Robin Ward 2016-03-11 15:58:33 -05:00
parent 2dbe071f96
commit 5cdc2c978a
1 changed files with 22 additions and 0 deletions

22
README.md Normal file
View File

@ -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