Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
A template for Github READMEs (Markdown) + Sublime Snippet

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

<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>
@jt3k
Copy link

jt3k commented Nov 27, 2015

good work. :[]

@addoull
Copy link

addoull commented Dec 6, 2015

thx

@JaymzZh
Copy link

JaymzZh commented Jan 5, 2016

Thanks.

@dexteradeus
Copy link

dexteradeus commented Feb 12, 2016

+1

@Loki-Afro
Copy link

Loki-Afro commented Mar 13, 2016

+1

@tonyedwardspz
Copy link

tonyedwardspz commented Apr 2, 2016

+1

@ledor473
Copy link

ledor473 commented Apr 21, 2016

👍

@excellenthua
Copy link

excellenthua commented Jun 3, 2016

Thanks, so useful for me!

@oscarr-reyes
Copy link

oscarr-reyes commented Jun 4, 2016

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

@adeluccar
Copy link

adeluccar commented Jun 4, 2016

👍

@iiiaxdellai
Copy link

iiiaxdellai commented Jun 9, 2016

Thanks, great stuff!

@Noe007
Copy link

Noe007 commented Aug 2, 2016

Thank You :D

@dimagalat
Copy link

dimagalat commented Aug 3, 2016

Thanks, this is very useful!

@yofayed
Copy link

yofayed commented Aug 4, 2016

Cool beans! Thanks!

@croworc
Copy link

croworc commented Aug 21, 2016

Thanks for sharing - much appreciated! 👍

@runninglee
Copy link

runninglee commented Sep 10, 2016

+1

@jeevanhr7
Copy link

jeevanhr7 commented Dec 14, 2016

+1

@mmuntakim15
Copy link

mmuntakim15 commented Dec 19, 2016

thanks

@mundipf
Copy link

mundipf commented Jan 13, 2017

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

@RobertWSaunders
Copy link

RobertWSaunders commented Mar 4, 2017

Nice!

@nafeu
Copy link

nafeu commented Mar 21, 2017

Awesome! Thanks :)

@amalshehu
Copy link

amalshehu commented Mar 31, 2017

Amazing!

@juanezamudio
Copy link

juanezamudio commented May 4, 2017

Thanks so much!

@sychonet
Copy link

sychonet commented Jun 20, 2017

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

@stenrdj
Copy link

stenrdj commented Sep 20, 2017

very usefull thanks

@cmhuang0328
Copy link

cmhuang0328 commented Nov 23, 2017

Thanks for sharing!

@tandavala
Copy link

tandavala commented Jan 19, 2018

good work. keep up!

@RafaelBroseghini
Copy link

RafaelBroseghini commented Apr 9, 2018

Well done thanks!

Copy link

ghost commented Jun 22, 2018

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

@xgqfrms
Copy link

xgqfrms commented Jul 5, 2020

LGTM 🕵️‍♂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment