Merge pull request #3 from bdougie/add-usage-instructions

Add usage instructions

.github/release-drafter.yml

@@ -0,0 +1,3 @@
+template: |
+ ## What’s Changed
+ $CHANGES

.github/workflows/release-management.yml

@@ -0,0 +1,16 @@
+name: Release Management
+
+on:
+ push:
+ # branches to consider in the event; optional, defaults to all
+ branches:
+ - master
+
+jobs:
+ update_draft_release:
+ runs-on: ubuntu-latest
+ steps:
+ # Drafts your next Release notes as Pull Requests are merged into "master"
+ - uses: toolmantim/[email protected]
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,2 +1,39 @@
 # Variables in Markdown
 This GitHub Action will allow you to set variables in Markdown and allow you to interpolate throughout your file.
+
+## Usage
+
+This GitHub Action that replaces template in your variables
+
+```yml
+on: issues
+name: Template Variables in Markdown
+jobs:
+ markdown:
+ name: markdown-marker
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@master
+ - uses: bdougie/variables-in-markdown@master
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+```
+
+This s best used with issue templates. Create an examples `.github/ISSUE_TEMPLATE.md` file. This file should have front matter to help construct the new issue:
+
+```markdown
+---
+title: New Issue
+labels: bug, enhancement
+---
+<!--#
+NOUN=mother
+ATTRIBUTION=Mark Wahlberg
+$-->
+
+"Say hi to your {{ NOUN }} for me," {{ ATTRIBUTION }}
+```
+
+You'll notice that the above example has some `{{ MUSTACHE }}` variables. This is need for the API to find and replace variables. This is powered by the [marky_markdown](https://rubygems.org/gems/marky_markdown) ruby gem.
+