Use the files in this repo as templates for your projects. Be sure to read through them, understand their implications, and fill in the placeholders.
cp templates/README.md.template my-awesome-project/README.md
$VISUAL my-awesome-project/README.mdThe README.md.template includes a dynamic README content snippet. That means the footer will be rendered and updated automatically for you with the contents from the footer template.
To make it work when using the README.md.template:
- copy the github workflow example
and rename it to
dynamic-readme. - add the repo path to the repository matrix in the workflow dispatch.
See the CONTRIBUTING document. Thank you, contributors!
Open source templates are Copyright (c) thoughtbot, inc. It contains free software that may be redistributed under the terms specified in the LICENSE file.
This repo is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.
We love open source software! See our other projects. We are available for hire.