No-nonsense 1-sentence project description.
bower install readme
mv readme/README.md README.md
rm -vr readmeWhat is this? Don't expect potential users to go through your code without prior explanation.
- Be specific, but don't be too technical yet.
- Don't skimp on hyperlinks. Google it for me. Add references to everything.
- Credit where it's due. We are all standing on the shoulders of giants.
Your readme is not a blog post, if you want to compare your project to pirates or ninjas you have more than several social artifacts at your disposal to express your creativity.
Writing technical specs should be akin to writing elegant algorithms. Be eloquent, but use simple vocabulary if you can.
Sometimes why can be more useful than what. Explain why this project exists and what problems it helps to solve. It's not about pitching your new MVC framework, it's about getting potential users to quickly understand the motivations and reasons behind your project.
Spoon-feed. Don't puzzle readers with your mad code skills. List the most common use cases of your project. High copy-paste factor for extra credits.
var awe = require('your-awesome-module');
awe.befill(function(obj) {
// Voila!
});Light specs to get people acquainted with your API. Optional.
- What is a Readme?
- How to Write a Readme
- Choosing a License
- Github's License Picker
- List of Software Licenses
- Github Help
Comments, feedback and / or pull requests are always welcome. Fork, commit, and open a pull request.