Here would be a very short description of the project. So in this example it would be a short information that this is a template that I use to start new projects and services.
- Update project name in
package.json
- Create
main
anddevelop
branches - Set
develop
as default branch - Create Docker Repository
- Add Repository Description
- Add secret:
DOCKERHUB_TOKEN
- Create npm Repository with
npm publish --access public
- Add secret:
NPM_TOKEN
- Add secret:
- Go through repo settings
git clone https://github.com/sebbo2002/template.git
cd ./template
npm install
This is where it would normally say how to use the project. This could be a code example for a library or instructions on how to use a CLI tool.
Is there an API that needs to be documented? Then here would be a nice place for it. If there is external documentation, you can link it here (example).
It's 3
🎉
Copyright (c) Sebastian Pekarek under the MIT license.