What do we really want in the README

[hmpf]

As is, the README is a good starting point, and we can start using the plugin without polishing it further. However, since it also is the only real place to document the plugin (docs/ would be overkill I feel) and it feels a bit too short and sweet I'll write down what I think would make it better, especially when we have a few more plugins in place.

• Maybe a pointer to argus-server's docs about ticket plugins, and especially the list of other plugins, when we have that list!
• Badges! Everything is better with badges. Makes the project look more mature than it is ;)
• Mention that the settings talked about is the instance specific Django settings file
• How to install
• How to test
• File-hierarchy and some comments pointing out the important bits, to make it easier for developers making their own plugins to understand what they need to focus on, for instance the requirements-*-files are generated by tox!

All of this should eventually go in the cookiecutter of course. And there should probably be a link to the cookiecutter, again, to make it easier for plugin-developers.

[hmpf]

Ouah, we must also mention which RT version this is for as RT has changed quite a bit through the years. Once upon a time it only worked via email.