From aa1c0f15447154f8a04f12dffce4d4d97dee9b25 Mon Sep 17 00:00:00 2001
From: Conrad <grosserconrad@gmail.com>
Date: Wed, 18 Mar 2020 14:17:01 +0100
Subject: [PATCH] Added proper README

---
 README.md     | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 action.yml    |  4 ---
 entrypoint.sh |  3 ++-
 3 files changed, 74 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index d0034c4..c7eb090 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,74 @@
 # GitHub Crush Action
 
-GitHub action for automatic lossless image compression using OptiPNG for PNG compression.
+GitHub action for automatic lossless image compression using OptiPNG for PNG compression and jpegoptim for JPG compression.
+
+## Usage
+
+### Parameters
+
+| Parameter | Required | Default | Description |
+| - | :-: | :-: | - |
+| commit_options | :x: | - | Custom git commit options |
+| commit_message | :x: | Prettified Code! | Custom git commit message |
+| file_pattern | :x: | * | Custom git add file pattern |
+| branch | :white_check_mark: | - | There are two types of action triggers in GitHub: on pull request and on push. The branch needs to be defined for both, but in case of the pull request trigger it should have `${{ github.head_ref }}` and on push it should have the branch the trigger is designed for. |
+
+### Example Config
+
+#### Example - On Pull Request
+
+This is a small example of what your `action.yml` could look like (on pull request mode):
+
+```yaml
+name: Optimising Pictures
+
+on: [pull_request]
+
+jobs:
+  cleanup_tasks:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Cloning the repository
+      uses: actions/checkout@v1
+      with:
+        fetch-depth: 1
+    - name: Prettify the JS Code
+      uses: creyD/crush_action@v1.0
+      with:
+        branch: ${{ github.head_ref }}
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+#### Example - On Push
+
+```yaml
+name: Optimising Pictures
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  cleanup_tasks:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Cloning the repository
+      uses: actions/checkout@v1
+      with:
+        fetch-depth: 1
+    - name: Prettify the JS Code
+      uses: creyD/crush_action@v1.0
+      with:
+        branch: master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+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/crush_action/issues/new). Thanks!
diff --git a/action.yml b/action.yml
index 245af9f..99f620f 100644
--- a/action.yml
+++ b/action.yml
@@ -18,10 +18,6 @@ inputs:
   branch:
     description: Target branch for the changes
     required: true
-  folder:
-    description: Folder the action searches
-    required: false
-    default: '.'
 
 runs:
   using: 'docker'
diff --git a/entrypoint.sh b/entrypoint.sh
index 92fbfac..1a17289 100755
--- a/entrypoint.sh
+++ b/entrypoint.sh
@@ -37,7 +37,8 @@ _git_push() {
 
 # PROGRAM
 find -type f -name "*.png" -exec optipng -quiet -nc -nb -o7 {} \;
-find -type f -name "*.jpg/*.jpeg" -exec jpegoptim {} \;
+find -type f -name "*.jpg" -exec jpegoptim {} \;
+find -type f -name "*.jpeg" -exec jpegoptim {} \;
 
 # To keep runtime good, just continue if something was changed
 if _git_changed;