Merge pull request #9 from devicons/develop

Added color and icon the action

Author: Thomas-Boi

.github/workflows/demo.yml

@@ -0,0 +1,34 @@
+name: Demo the action
+on: workflow_dispatch
+jobs:
+  demo:
+    name: Demo the repo's capability
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Upload a single file
+        uses: devicons/public-upload-to-imgur@v2
+        id: step_1
+        with:
+          path: ./docs/example.png
+          client_id: ${{secrets.IMGUR_CLIENT_ID}}
+      - name: Upload a folder with multiple files
+        uses: devicons/public-upload-to-imgur@v2
+        id: step_2
+        with:
+          path: ./docs/
+          client_id: ${{secrets.IMGUR_CLIENT_ID}}
+      - name: Upload a glob pattern
+        uses: devicons/public-upload-to-imgur@v2
+        id: step_3
+        with:
+          path: ./*.png
+          client_id: ${{secrets.IMGUR_CLIENT_ID}}
+      - name: View results
+        env:
+          STEP_1_RESULT: ${{ fromJSON(steps.step_1.outputs.imgurls)[0] }}  # view only one result
+          STEP_2_RESULT: ${{ steps.step_2.outputs.imgurls }}  
+          STEP_3_RESULT: ${{ steps.step_3.outputs.imgurls }}  
+        run: |
+          echo $STEP1_RESULT
+          echo $STEP2_RESULT
+          echo $STEP3_RESULT

README.md

@@ -2,8 +2,9 @@
 A GitHub Action that can upload "anonymous" images to Imgur using their API and give you the URL of the newly created image.
 Note: "anonymous" means that the image is not tied to an account (see [this](https://apidocs.imgur.com/#intro)).
 
+**Purpose** 
 This action is used as part of the peek-icons workflow in the [devicon](https://github.com/devicons/devicon) repo to automate the
-icon checking process.
+icon checking process. Our workflow would generate screenshots using Selenium, upload it to Imgur (using this action) then publish a comment on a PR showing the result (using [another action](https://github.com/marketplace/actions/pr-comment)).
 
 ## How To Use ##
 
@@ -96,13 +97,13 @@ steps:
 ```
 
 
-**Final Result**
-
-
-Here's a real life example from our [devicon](https://github.com/devicons/devicon) repo:
+**Real Life Examples**
+Here's an usecase from our [devicon](https://github.com/devicons/devicon) repo:
 
 ![GitHub bot using the action](docs/example.PNG)
 
+You can also view the [example workflow]() and the [resulting action]() in this repo.
+
 ## Credits ##
 The script for parsing multiple paths and glob inputs was taken from the [upload-artifacts](https://github.com/actions/upload-artifact/blob/main/src/search.ts) repo. 
 

action.yml

@@ -1,5 +1,7 @@
-name: 'Upload To Imgur'
-description: 'Upload image(s) to Imgur using their API'
+name: 'Publish on imgur'
+description: 'Upload image(s) to imgur using their API'
+icon: 'image'
+color: 'green'
 inputs:
   path:  
     description: 'Path to the images'