README
template
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.
🚨 Template Usage Checklist
- Update project name in
package.json
- Create
main
anddevelop
branches - Set
develop
as default branch - Create Docker Repository
- Add secret:
DOCKERHUB_TOKEN
- Add secret:
- Creat npm Repository
- Add secret:
NPM_TOKEN
- Add secret:
- Go through repo settings
📦 Installation
git clone https://github.com/sebbo2002/template.git
cd ./template
npm install
⚡️ Quick Start
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.
📑 API-Reference
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).
🙋 FAQ
1
+ 2
What's It's 3
🎉
🙆🏼♂️ Copyright and license
Copyright (c) Sebastian Pekarek under the MIT license.