📝 Updates documentation

Author: rickstaa

README.md

@@ -1,148 +1,96 @@
-# Reviewdog/action-remark-lint GitHub Action
+# Action-remark-lint GitHub Action
 
-[![Test](https://github.com/reviewdog/action-remark-lint/workflows/Test/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3ATest)
-[![reviewdog](https://github.com/reviewdog/action-remark-lint/workflows/reviewdog/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Areviewdog)
-[![depup](https://github.com/reviewdog/action-remark-lint/workflows/depup/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Adepup)
-[![release](https://github.com/reviewdog/action-remark-lint/workflows/release/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Arelease)
-[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-remark-lint?logo=github\&sort=semver)](https://github.com/reviewdog/action-remark-lint/releases)
+[![Test](https://github.com/rickstaa/action-remark-lint/workflows/Test/badge.svg)](https://github.com/rickstaa/action-remark-lint/actions?query=workflow%3ATest)
+[![release](https://github.com/rickstaa/action-remark-lint/workflows/release/badge.svg)](https://github.com/rickstaa/action-remark-lint/actions?query=workflow%3Arelease)
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rickstaa/action-remark-lint?logo=github\&sort=semver)](https://github.com/rickstaa/action-remark-lint/releases)
 [![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github\&link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)
 
-![action screenshot](https://user-images.githubusercontent.com/17570430/102060312-4ee5e000-3df2-11eb-8c82-767afeccd8db.png)
-![action screenshot](https://user-images.githubusercontent.com/17570430/102059912-d3842e80-3df1-11eb-9b0a-2e04eab5e294.png)
-
-This action runs [remark-lint](https://github.com/remarkjs/remark-lint) with [reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve code review experience. It can be used to format your code and/or annotate possible changes that would be made during this formatting.
+This action runs the [remark-lint linter](https://github.com/remarkjs/remark-lint) to check/format your markdown code on a push or pull request.
 
 ## Quickstart
 
 ```yml
-name: reviewdog
-on: [pull_request]
+name: remark-lint-action
+on: [push, pull_request]
 jobs:
   remark-lint:
     name: runner / remark-lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
       - name: remark-lint
-        uses: reviewdog/action-remark-lint@v1
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          reporter: github-pr-check # Change reporter. (Only `github-pr-check` is supported at the moment).
+        uses: rickstaa/action-remark-lint@v1
 ```
 
-See the Inputs section below for details on the defaults and optional configuration settings.
-
 ## Inputs
 
-### `github_token`
-
-**Required**. Must be in form of `github_token: ${{ secrets.github_token }}`'.
-
-### `workdir`
-
-**Optional**. The directory to run remark-lint in. Defaults to `.`.
-
-### `format`
-
-**Optional**. If true, remark-lint format files and commit are creatable (use other Action). Defaults to `false`.
-
-#### `fail_on_error`
-
-**Optional**. Exit code for when remark-lint errors are found \[`true`, `false`]. Defaults to `false`. This is different than the remark-lint `--frail` argument, which specifies whether remark exits with an exit code of `1` if remark warnings are found.
-
-#### `remark_flags`
-
-**Optional**. Additional remark-lint flags. Defaults to `""`.
-
-### `annotate`
+### `remark_args`
 
-**Optional**. Annotate remark-lint changes using reviewdog. Defaults to `true`.
+**optional**: Remark-lint input arguments. Defaults to `. --frail --quiet`.
 
-#### `tool_name`
+### `fail_on_error`
 
-**Optional**. Tool name to use for reviewdog reporter. Defaults to `remark-lint`.
-
-### `level`
-
-**Optional**. Report level for reviewdog \[info, warning, error]. It's same as `-level` flag of reviewdog. Defaults to `error`.
-
-### `reporter`
-
-**Optional**. Reporter of reviewdog command \[github-pr-check, github-pr-review, github-check].
-Default is github-pr-check. github-pr-review can use Markdown and add a link to rule page in reviewdog reports.
-
-### `filter_mode`
-
-**Optional**. Filtering mode for the reviewdog command \[added, diff_context, file, nofilter]. Defaults to `"added"`.
-
-### `reviewdog_flags`
-
-**Optional**. Additional reviewdog flags. Defaults to `""`.
+**optional**: Exit code when remark-lint linting errors are found \[true, false]. Defaults to 'true'.
 
 ## Outputs
 
 ### `is_formatted`
 
-Whether the files were formatted using the remark-lint linter.
+Boolean specifying whether any files were formatted using the remark-lint linter.
 
-## Advance use cases
+## Advanced use cases
 
-This action can be combined with [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) or [stefanzweifel/git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) to also apply the annotated changes to the repository.
+### Annotate changes
 
-### Commit changes
+This action can be combined with [reviewdog/action-suggester](https://github.com/reviewdog/action-suggester) also to annotate any possible changes (uses `git diff`).
 
 ```yaml
-name: reviewdog
-on: [pull_request]
+name: remark-lint-action
+on: [push, pull_request]
 jobs:
   name: runner / remark-lint
   runs-on: ubuntu-latest
   steps:
     - uses: actions/checkout@v2
+    - name: Check files using the remark-lint linter
+      uses: rickstaa/action-remark-lint@v1
+      id: action_remark_lint
       with:
-        ref: ${{ github.head_ref }}
-    - name: Check files using remark-lint linter
-      uses: reviewdog/action-remark-lint@v1
+        remark_args: ". -o"
+    - name: Annotate diff changes using reviewdog
+      if: steps.action_remark_lint.outputs.is_formatted == 'true'
+      uses: reviewdog/action-suggester@v1
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        reporter: github-check
-        level: error
-        fail_on_error: true
-        format: true
-    - name: Commit remark-lint formatting results
-      if: failure()
-      uses: stefanzweifel/git-auto-commit-action@v4
-      with:
-        commit_message: ":art: Format markdown code with remark-lint push"
+        tool_name: remarkfmt
 ```
 
-### Create pull request
+### Commit changes or create a pull request
+
+This action can be combined with [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) to also apply the annotated changes to the repository.
 
 ```yaml
-name: reviewdog
-on: [pull_request]
+name: remark-lint-action
+on: [push, pull_request]
 jobs:
   name: runner / remark-lint
   runs-on: ubuntu-latest
   steps:
     - uses: actions/checkout@v2
     - name: Check files using remark-lint linter
-      uses: reviewdog/action-remark-lint@v1
+      uses: rickstaa/action-remark-lint@v1
+      id: action_remark_lint
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        reporter: github-check
-        level: error
-        fail_on_error: true
-        format: true
+        remark_args: ". -o"
     - name: Create Pull Request
-      if: failure()
+      if: steps.action_remark_lint.outputs.is_formatted == 'true'
       uses: peter-evans/create-pull-request@v3
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
-        title: "Format markdown code with remark-lint linter"
-        commit-message: ":art: Format markdown code with remark-lint linter"
+        title: "Format Python code with remark-lint linter"
+        commit-message: ":art: Format Python code with remark-lint"
         body: |
           There appear to be some python formatting errors in ${{ github.sha }}. This pull request
           uses the [remark-lint](https://github.com/remarkjs/remark-lint) linter to fix these issues.
+        base: ${{ github.head_ref }} # Creates pull request onto pull request or commit branch
         branch: actions/remark-lint
 ```