/thanks-md

Where people comment and say how the project helped them

MIT LicenseMIT

THANKS.md

where people comment and say how the project helped them

This is a specification for creating a specific place in a project where people can tell the maintainers how the project helped them.

The idea is comes from this Twitter exchange:

Specification

  • Create a file called THANKS.md
  • Add a short message at the top of the THANKS.md file to say "Thanks" to the people that use your project
  • Add some notice to the projects README to indicate that the project has a THANKS.md
  • (Optional) Add the THANKS.md badge to the project README

Example

See THANKS.md in this repository for a template.

How to Add the Badge

Paste the line below into your markdown file.

![](https://img.shields.io/badge/THANKS-md-ff69b4.svg)

Tips

Add THANKS.md merge=union to your repository's .gitattributes file to avoid benign merge conflicts.

Install

There's nothing to install.

License

MIT © Paul Molluzzo