diff --git a/README.md b/README.md
index 6a1dc6c6904..29795c6fbf9 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,24 @@
-[](https://github.com/tj-actions/changed-files/actions/workflows/test.yml) [](https://github.com/tj-actions/changed-files/actions/workflows/sync-release-version.yml) [](https://github.com/search?o=desc&q=tj-actions+changed-files+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code)
+[](https://github.com/tj-actions/changed-files/actions/workflows/test.yml) [](https://github.com/tj-actions/changed-files/actions/workflows/sync-release-version.yml) [](https://github.com/search?o=desc\&q=tj-actions+changed-files+path%3A.github%2Fworkflows+language%3AYAML\&s=\&type=Code)
-changed-files
--------------
+## changed-files
Retrieve all changed files relative to the default branch (`pull_request*` events) or a previous commit (`push` event) returning the **absolute path** to all changed files from the project root.
-
## Features
-- List all files that have changed.
- - Between the current pull request branch and the default branch.
- - Between the last commit and the current pushed change.
-- Restrict change detection to a subset of files.
- - Report on files that have at least one change.
- - Regex pattern matching on a subset of files.
+* List all files that have changed.
+ * Between the current pull request branch and the default branch.
+ * Between the last commit and the current pushed change.
+* Restrict change detection to a subset of files.
+ * Report on files that have at least one change.
+ * Regex pattern matching on a subset of files.
## Usage
> NOTE: :warning:
-> * **IMPORTANT:** For `push` events to work you need to include `fetch-depth: 0` **OR** `fetch-depth: 2` depending on your use case.
-> * When using `persist-credentials: false` with `actions/checkout@v2` you'll need to specify a `token` using the `token` input.
-
+>
+> * **IMPORTANT:** For `push` events to work you need to include `fetch-depth: 0` **OR** `fetch-depth: 2` depending on your use case.
+> * When using `persist-credentials: false` with `actions/checkout@v2` you'll need to specify a `token` using the `token` input.
```yaml
name: CI
@@ -53,7 +51,6 @@ jobs:
done
```
-
## Outputs
| Acronym | Meaning |
@@ -67,22 +64,20 @@ jobs:
| U | Unmerged |
| X | Unknown |
-
| Output | type | example | description |
|:--------------------:|:------------:|:----------------------------------:|:----------------------------------------:|
| any_changed | `string` | `true` OR `false` | Returns `true` when any of the filenames provided using the `files` input has changed |
| all_modified_files | `string` | `'new.txt path/to/file.png ...'` | Select all modified files
i.e. *a combination of all added,
copied and modified files (ACM).* |
-| all_changed_files | `string` | `'new.txt path/to/file.png ...'` | Select all paths (*)
i.e. *a combination of all options below.* |
+| all_changed_files | `string` | `'new.txt path/to/file.png ...'` | Select all paths (\*)
i.e. *a combination of all options below.* |
| added_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Added (A) |
| copied_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Copied (C) |
| deleted_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Deleted (D) |
| modified_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Modified (M) |
| renamed_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Renamed (R) |
-| changed_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that have their file type changed (T) |
+| changed_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that have their file type changed (T) |
| unmerged_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Unmerged (U) |
| unknown_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Unknown (X) |
-
## Inputs
| Input | type | required | default | description |
@@ -164,40 +159,34 @@ jobs:
token: ${{ secrets.github_token }}
```
-
## Example
-
+
-
-* Free software: [MIT license](LICENSE)
+* Free software: [MIT license](LICENSE)
If you feel generous and want to show some extra appreciation:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
-[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
+[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
-Credits
--------
+## Credits
This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter).
-
-
-Report Bugs
------------
+## Report Bugs
Report bugs at https://github.com/tj-actions/changed-files/issues.
If you are reporting a bug, please include:
-* Your operating system name and version.
-* Any details about your workflow that might be helpful in troubleshooting.
-* Detailed steps to reproduce the bug.
+* Your operating system name and version.
+* Any details about your workflow that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.