Bumped the version and added release notes

Updated the README

.github/workflows/release-workflow.yml

@@ -21,8 +21,8 @@ jobs:
         token: ${{ secrets.GITHUB_TOKEN }}
         tag: ${{ steps.app-version.outputs.VERSION }}
         commit: master
-        name: Shell Linter v0.3.0
-        bodyFile: ./docs/release_notes/v0.3.0.md
+        name: Shell Linter v0.4.0
+        bodyFile: ./docs/release_notes/v0.4.0.md
 
     - name: Update latest tag
       run: ./src/tagging.sh ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -11,7 +11,7 @@ A GitHub Action that performs static analysis for shell scripts using [ShellChec
 
 <br>
 
-## Usage
+# Usage
 
 Shell Linter can perform static analysis in various ways. You can use it to lint all the shell scripts in your project or lint a a specific file or folder using the `path` parameter. Specific use cases are shown below:
 
@@ -21,55 +21,61 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout code
       - uses: actions/checkout@v1
-      - name: Lint check
+      - name: Run Shellcheck
         uses: azohra/shell-linter@v0.3.0
 ```
 
 Run static analysis for a single shell script.
 ```yml
-      - name: Lint check
+      - name: Run Shellcheck
         uses: azohra/shell-linter@v0.3.0
         with:
           path: "setup.sh"
 ```
 
 Run static analysis for multiple shell scripts **with or without** extension.
 ```yml
-      - name: Lint check
+      - name: Run Shellcheck
         uses: azohra/shell-linter@v0.3.0
         with:
           path: "setup,deploy.sh"
 ```
 
 Run static analysis for all the shell scripts in a folder.
 ```yml
-      - name: Lint check
+      - name: Run Shellcheck
         uses: azohra/shell-linter@v0.3.0
         with:
           path: "src"
 ```
 
 Run static analysis using a **wildcard** path.
 ```yml
-      - name: Lint check
+      - name: Run Shellcheck
         uses: azohra/shell-linter@v0.3.0
         with:
           path: "src/*.sh"
 ```
 
 Run static analysis for all the shell scripts and only report issue with error severity.
 ```yml
-      - name: Lint check
+      - name: Run Shellcheck
         uses: azohra/shell-linter@v0.3.0
         with:
           path: "src/*.sh"
           severity: "error"
 ```
+Run analysis using the **latest** stable version of Shell Linter
+```yml
+      - name: Run Shellcheck
+        uses: azohra/shell-linter@latest
+        with:
+          path: "src"
+```
 
-<br>
-
-## Input
+# Input
 
 ### `path`
 
@@ -79,7 +85,5 @@ Optional. Execute lint check on a specific file or folder. Default: `.`
 
 Optional. Specify minimum severity of errors to consider [style, info, warning, error]. Default: `style`
 
-<br>
-
-## License
+# License
 This software is available as open source under the terms of the MIT License.

docs/release_notes/v0.4.0.md

@@ -0,0 +1,4 @@
+- Added support for ShellCheck severity mode
+  - The default behavior is set to `style` which considers errors with all severity levels
+- Improved tagging
+  - The latest stable version can be fetched by using `@latest`

docs/version

@@ -1,4 +1,4 @@
 #! /bin/bash
 
-VERSION="v0.3.0"
+VERSION="v0.4.0"
 echo $VERSION