📝 feat(doc): add summary

This commit is contained in:
Bouteiller Alan 2020-07-09 10:28:48 +02:00
parent d88364e873
commit 0d99f29219
No known key found for this signature in database
GPG Key ID: EE8C5F9452E04F4E

View File

@ -9,6 +9,19 @@ with the ref of the commit that it was closed by.
The `# TODO` comment is commonly used in Python, but this can be customised to whatever you want.
## Summary
- [Usage](#usage)
- [workflow.yaml](#workflowyaml)
- [inputs](#inputs)
- [Examples](#examples)
- [Adding TODOs](#adding-todos)
- [Multiline TODOs](#multiline-todos)
- [Removing TODOs](#removing-todos)
- [Updating TODOs](#updating-todos)
- [In an existing repo with existing todo](#in-an-existing-repo-with-existing-todo)
- [Contributing & Issues](#contributing--issues)
- [Thanks](#thanks)
## Usage
Create a workflow file in your .github/workflows directory as follows: