This is a IM application written purely in Python and uses web.py. The idea was to use the pub/sub model of mqtt and create a chat application. This is a web based application which makes use of websockets, mqtt, redis and ldap.
At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
Give examples
A step by step series of examples that tell you have to get a development env running
Stay what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
Explain how to run the automated tests for this system
Explain what these tests test and why
Give an example
Explain what these tests test and why
Give an example
Add additional notes about how to deploy this on a live system
- Dropwizard - Bla bla bla
- Maven - Maybe
- Atom - ergaerga
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- John Doe - Initial work - JohnDoe
See also the list of contributors who participated in this project.
This project is licensed under the BSD License - see the LICENSE.md file for details.
- Hat tip to anyone who's code was used
- Inspiration
- etc