A template for Github READMEs (Markdown) + Sublime Snippet

README.md

Project Name

TODO: Write a project description

Installation

TODO: Describe the installation process

Usage

TODO: Write usage instructions

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

History

TODO: Write history

Credits

TODO: Write credits

License

TODO: Write license

readme.sublime-snippet

<snippet>
  <content><![CDATA[
# ${1:Project Name}

TODO: Write a project description

## Installation

TODO: Describe the installation process

## Usage

TODO: Write usage instructions

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## History

TODO: Write history

## Credits

TODO: Write credits

## License

TODO: Write license
]]></content>
  <tabTrigger>readme</tabTrigger>
</snippet>

good work. :[]

thx

Thanks.

+1

+1

+1

👍

Thanks, so useful for me!

Needed something like this.. nice you have made up a template

👍

Thanks, great stuff!

Thank You :D

Thanks, this is very useful!

Cool beans! Thanks!

Thanks for sharing - much appreciated! 👍

+1

+1

thanks

Is there a way to automate the use of such a template whenever a new repo is created for an account?

Nice!

Awesome! Thanks :)

Amazing!

Thanks so much!

Was looking for a template like this. Thanks for sharing.

very usefull thanks

Thanks for sharing!

good work. keep up!

Well done thanks!

Thanks for the example Thanks !!!!!!!!

LGTM 🕵️‍♂️