Merge pull request #380 from Start-Out/docs/actions-workflow

DOCS: Actions Workflow

README.md

@@ -9,6 +9,7 @@
 
 <!-- TOC start (generated with https://github.com/derlin/bitdowntoc) -->
 
+- [Quick Start](#quick-start)
 - [Overview](#overview)
 - [Example](#example)
 - [Contributing](#contributing)
@@ -17,17 +18,17 @@
 
 <!-- TOC end -->
 
-## Overview
+<!-- TOC --><a name="quick-start"></a>
+## Quick Start
 
-> TODO or not to do, that is the question
+[Use todoon in your workflows!](https://github.com/marketplace/actions/todo-or-not)
 
-TODO Or Not (todoon) is, in essence, a simple tool that checks your project for TODOs and FIXMEs and lets you know where they are. 
-
-You can also integrate this tool into your GitHub workflow via actions, and automate generating issues from the discovered TODOs and
-FIXMEs. These generated issues will include a link to the file in GitHub as well as the surrounding lines. [Check out the wiki](https://github.com/Start-Out/todo-or-not/wiki/Commands-%E2%80%90-todoignore%E2%80%90util) for 
-more details on the GitHub Issues integration!
+```yaml
+  - name: TODO-Or-Not
+    uses: Start-Out/actions@v1
+```
 
-[Try it out! (see on PyPi)](https://pypi.org/project/todo-or-not/)  
+[Try it out locally! (see on PyPi)](https://pypi.org/project/todo-or-not/)  
 Or, if you are using Arch Linux, there is an [AUR Package](https://aur.archlinux.org/packages/python-todo-or-not) maintained by @mward25.
 
 ```bash
@@ -37,6 +38,19 @@ todoignore-util -ut .git
 todoon
 ```
 
+<!-- TOC --><a name="overview"></a>
+## Overview
+
+> TODO or not to do, that is the question
+
+TODO Or Not (todoon) is, in essence, a simple tool that checks your project for TODOs and FIXMEs and lets you know where they are. 
+
+You can also integrate this tool into your GitHub workflow via actions, and automate generating issues from the discovered TODOs and
+FIXMEs. These generated issues will include a link to the file in GitHub as well as the surrounding lines. [Check out the wiki](https://github.com/Start-Out/todo-or-not/wiki/Commands-%E2%80%90-todoignore%E2%80%90util) for 
+more details on the GitHub Issues integration!
+
+
+<!-- TOC --><a name="example"></a>
 ## Example
 
 Check out [this example code](blob/dev/staging/example.py) and
@@ -83,14 +97,17 @@ def a_very_pretty_example():
 
 ```
 
+<!-- TOC --><a name="contributing"></a>
 ## Contributing
 
 Please target `dev/contribute` with your fork, and please use the appropriate PR template! 
 
+<!-- TOC --><a name="help"></a>
 ## Help
 
 [See the wiki!](https://github.com/Start-Out/todo-or-not/wiki)
 
+<!-- TOC --><a name="fun-promo-video"></a>
 ## Fun Promo Video
 
 https://github.com/Start-Out/todo-or-not/assets/10158233/d2c860f6-efd8-4ca4-b5d6-fcabe0bae6ce