Upgraded to new yml syntax

gaurav-nelson · Aug 27, 2019 · 33f569d · 33f569d
1 parent 59abf54
commit 33f569d
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 18 deletions.
diff --git a/.github/main.workflow b/.github/main.workflow
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -0,0 +1,9 @@
+on: push
+name: New workflow
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: markdown-link-check
+      uses: ./
diff --git a/README.md b/README.md
@@ -1,17 +1,24 @@
 # GitHub Action - Markdown link check 🔗✔️
 This GitHub action checks all Markdown files in your repository for broken links. (Uses [tcort/markdown-link-check](https://github.com/tcort/markdown-link-check))
 
-## Sample workflow
-```
-workflow "New workflow" {
-  on = "push"
-  resolves = ["markdown-link-check"]
-}
+## How to use
+1. Create a new file in your repository `.github/workflows/action.yml`.
+1. Copy-paste the folloing workflow in your `action.yml` file:
 
-action "markdown-link-check" {
-  uses = "./"
-}
-```
+   ```yml
+   name: Check Markdown links
+
+   on: push
+
+   jobs:
+     markdown-link-check:
+       runs-on: ubuntu-latest
+       steps:
+       - uses: actions/checkout@master
+         with:
+           fetch-depth: 1
+       - uses: gaurav-nelson/github-action-markdown-link-check@v0.2.0
+   ```
 
 ## Test links