A little info about your project and/ or overview that explains what the project is about.
A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.
Build status of continus integration i.e. travis, appveyor etc. Ex. -
If you're using any code style like xo, standard etc. That will help others while contributing to your project. Ex. -
Include logo/demo screenshot etc.
Ex. -
Built with
What makes your project stand out?
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.
Provide step by step series of examples and explanations about how to get a development env running.
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.
Describe and show how to run the tests with code examples.
If people like your project they’ll want to learn how they can use it. To do so include step by step guide to use your project.
Let people know how they can contribute into your project. A contributing guideline will be a big plus.
Give proper credits. This could be a link to any repo which inspired you to build this project, any blogposts or links to people who contrbuted in this project.
A short snippet describing the license (MIT, Apache etc)
MIT © Humza Hasan
One Paragraph of project description goes here
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 how to get a development env running
Say 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
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 - The web framework used
- Maven - Dependency Management
- ROME - Used to generate RSS Feeds
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.
- Humza Hasan - Initial work - PurpleBooth
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone whose code was used
- Inspiration
- etc
Here goes your awesome project description!
Add more general information about project. What the purpose of the project is? Motivation?
- Tech 1 - version 1.0
- Tech 2 - version 2.0
- Tech 3 - version 3.0
Describe how to install / setup your local environement / add link to demo version.
Show examples of usage:
put-your-code-here
List of features ready and TODOs for future development
- Awesome feature 1
- Awesome feature 2
- Awesome feature 3
To-do list:
- Wow improvement to be done 1
- Wow improvement to be done 2
Project is: in progress, finished, no longer continue and why?
Add here credits. Project inspired by..., based on...
Created by @humzahasan - feel free to contact me!