Minor Cleanup

.gitignore

@@ -0,0 +1,2 @@
+# MacOS system files
+.DS_Store

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+Be excellent to each other.

README.md

@@ -1,5 +1,10 @@
 # GitHub autoflake Action
 
+[![License MIT](https://img.shields.io/github/license/creyD/autoflake_action)](https://github.com/creyD/autoflake_action/blob/master/LICENSE)
+[![Latest Release](https://img.shields.io/github/v/release/creyD/autoflake_action)](https://github.com/creyD/autoflake_action/releases)
+[![Contributors](https://img.shields.io/github/contributors-anon/creyD/autoflake_action)](https://github.com/creyD/autoflake_action/graphs/contributors)
+[![Issues](https://img.shields.io/github/issues/creyD/autoflake_action)](https://github.com/creyD/autoflake_action/issues)
+
 This GitHub action automatically removes unused imports and variables from your Python code using [autoflake](https://pypi.org/project/autoflake/).
 
 ## Usage
@@ -15,15 +20,16 @@ The following parameters can be used in your custom action configuration.
 | no_commit | :x: | False | Avoid committing, if used in a pipeline |
 | options | :x: | ' ' | Parameters to use with autoflake |
 | dry | :x: | false | Dry-run the action to fail when detecting uncompliant files, instead of automatically fixing them. |
+| github_token | :x: | `${{ github.token }}` | The default [GITHUB_TOKEN](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret) or a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
 
+> Note: using the same_commit option may lead to problems if other actions are relying on the commit being the same before and after the prettier action has ran. Keep this in mind.
 
 ### Example
 
 This is a simple usage example of this script:
 
 ```yaml
-# This action works with pull requests and pushes
-name: Continuous Integration
+name: autoflake format
 
 on:
   pull_request:
@@ -37,12 +43,13 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-    - uses: creyD/autoflake_action@master
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
+    - uses: creyD/autoflake_action@v1.1
+      with:
+          options: --in-place --remove-all-unused-imports -r
 ```
 
+More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
+
 ## Issues
 
 Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/autoflake_action/issues/new).

action.yml

@@ -31,6 +31,10 @@ inputs:
     description: Can be used to avoid committing the changes
     required: false
     default: false
+  github_token:
+    description: GitHub Token or PAT token used to authenticate against a repository
+    required: false
+    default: ${{ github.token }}
 
 runs:
   using: 'docker'

entrypoint.sh

@@ -2,6 +2,7 @@
 # e is for exiting the script automatically if a command fails, u is for exiting if a variable is not set
 # x would be for showing the commands before they are executed
 set -eu
+shopt -s globstar
 
 # FUNCTIONS
 # Function for setting up git env in the docker container (copied from https://github.com/stefanzweifel/git-auto-commit-action/blob/master/entrypoint.sh)
@@ -25,6 +26,10 @@ _git_changed() {
     [[ -n "$(git status -s)" ]]
 }
 
+_git_changes() {
+    git diff
+}
+
 git config --global --add safe.directory /github/workspace
 
 echo "Running autoflake..."
@@ -37,7 +42,9 @@ fi
 if _git_changed;
 then
   if $INPUT_DRY; then
-    echo "Found non-compliant files!"
+    echo "Unpretty Files Changes:"
+    _git_changes
+    echo "Finishing dry-run. Exiting before committing."
     exit 1
   else
     # Calling method to configure the git environemnt