Added README

Author: goruha

README.yaml

@@ -5,11 +5,12 @@
 #
 
 # Name of this project
-name: example-github-action-composite
+name: github-action-docker-image-exists
 
 # Tags of this project
 tags:
   - github-action
+  - docker
 
 # Logo for this project
 #logo: docs/logo.png
@@ -18,25 +19,25 @@ tags:
 license: "APACHE2"
 
 # Canonical GitHub repo
-github_repo: cloudposse/example-github-action-composite
+github_repo: cloudposse/github-action-docker-image-exists
 
 # Badges to display
 badges:
   - name: "Latest Release"
-    image: "https://img.shields.io/github/release/cloudposse/example-github-action-composite.svg"
-    url: "https://github.com/cloudposse/example-github-action-composite/releases/latest"
+    image: "https://img.shields.io/github/release/cloudposse/github-action-docker-image-exists.svg"
+    url: "https://github.com/cloudposse/github-action-docker-image-exists/releases/latest"
   - name: "Slack Community"
     image: "https://slack.cloudposse.com/badge.svg"
     url: "https://slack.cloudposse.com"
 
-related: []
+related:
+  - name: "github-action-docker-build-push"
+    description: "Build Docker image and push it"
+    url: "https://github.com/cloudposse/github-action-docker-build-push"
 
-# Short description of this project
-description: Template repository of composite GitHub Action
 
-introduction: |-
-  This is template repository to create composite GitHub Actions. 
-  Feel free to use it as reference and starting point.
+# Short description of this project
+description: Check if docker image exists by pulling it
 
 references:
   - name: "github-actions-workflows"
@@ -49,24 +50,31 @@ references:
 # How to use this project
 usage: |-
   ```yaml
-    name: Pull Request
+    name: Push into main branch
     on:
-      pull_request:
-        branches: [ 'main' ]
-        types: [opened, synchronize, reopened, closed, labeled, unlabeled]
+      push:
+        branches: [ master ]
 
     jobs:
       context:
         runs-on: ubuntu-latest
-        steps:
-          - name: Example action
-            uses: cloudposse/example-github-action-composite@main
-            id: example
+        continue-on-error: true  
+        steps:  
+          - name: Check image
+            id: image_exists
+            uses: cloudposse/github-action-docker-image-exists@main
             with:
-              param1: true
+              registry: registry.hub.docker.com
+              organization: "${{ github.event.repository.owner.login }}"
+              repository: "${{ github.event.repository.name }}"
+              login: "${{ secrets.DOCKERHUB_USERNAME }}"
+              password: "${{ secrets.DOCKERHUB_PASSWORD }}"
+              tag: latest
   
-        outputs:
-          result: ${{ steps.example.outputs.result1 }}
+      outputs:
+        result: ${{ steps.image_exists.conclusion }}  
+        image: ${{ steps.image_exists.outputs.image }}
+        tag: ${{ steps.image_exists.outputs.tag }}
   ```
 
 include: