Merge pull request #4 from donaldwasserman/master

Added some clairification to docs
nextreleaseio · Dec 5, 2019 · 27f66e6 · 27f66e6
2 parents 377d435 + 3e1ebff
commit 27f66e6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -8,22 +8,21 @@ This is built by the team at [Next Release](https://www.nextrelease.io), but wil
 
 ## Quick Start
 
-
 ```yml
 on:
   release:
     types: [published]
 jobs:
   generate_changelog:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-latest # Configure this based on your needs
     name: Update Changelog
     steps:
       - name: Create Changelog.md
         id: changelog
         uses: nextrelease/next-release-changelog-action@master
         with:
           token: ${{ secrets.GITHUB_TOKEN }} # Required
-          changelog: 'CHANGELOG.md' # optional, default: CHANGELOG.md
+          changelog: "CHANGELOG.md" # optional, default: CHANGELOG.md
 ```
 
 ## How It Works

diff --git a/workflow.example.yml b/workflow.example.yml
@@ -3,7 +3,7 @@ on:
     types: [published]
 jobs:
   generate_changelog:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-latest # Configure this based on your needs
     name: Update Changelog
     steps:
       - name: Create Changelog.md