update readme

Author: saffi-codefresh

README.md

@@ -1,7 +1,59 @@
-# csdp-report-image
-This repository builds a container image that reports created image to Codefresh, for CI tools use.
-Providing parameters is done by having CF_ prefixed environment variables.
+# codefresh-report-image
+This image allows you to enrich images reported to Codefresh GitOps Platform. 
+Using this action you are able to report an image to Codefresh and enrich it with valuable information that will be displayed in Codefresh dashboards.
 
+### Image Metadata
+* Name
+* Size
+* Operating System and Architecture
+* Last Updated date
+
+### Git
+Commit that resulted in the image being built
+* Repository + Branch
+* Commit Message
+* Committer
+
+### Build
+* Image Size
+* Link to Job
+
+### Jira - Associated Jira issue
+* Issue ID
+* Title
+* Assigned to
+* Status
+
+## Example - github-actions
+  ```
+  - name: report image by action
+        with:
+          CF_IMAGE: ${{ secrets.DOCKERHUB_USERNAME }}/my-image-name:tag
+          CF_ENRICHERS: "jira, git"
+          CF_HOST: "https://my-runtime-url"
+          CF_API_KEY: ${{ secrets.CF_TOKEN }}
+          
+          #Codefresh Integrations to USE
+          CF_CONTAINER_REGISTRY_INTEGRATION: "dockerhub"
+          CF_JIRA_INTEGRATION: "jira"
+
+                 
+          "CF_GITHUB_TOKEN": ${{ secrets.GIT_TOKEN }}
+          
+          #Github metadata
+          "CF_GIT_PROVIDER": "github"
+          "CF_GIT_REPO": "idan-codefresh/example-github-action-use-csdp-report-image"
+          "CF_GIT_BRANCH": "main"
+          
+	      #Jira issues that match
+          "CF_JIRA_MESSAGE": "CR-12293"
+          "CF_JIRA_PROJECT_PREFIX": "CR"
+        uses: codefresh-io/csdp-report-image@0.0.46
+
+  ```
+
+
+# Complete List of Arguments
 ## Required
 * CF_API_KEY
 * CF_IMAGE
@@ -20,40 +72,33 @@ For each specific connection (such as jira) parameters can be provided explicitl
 * Bellow is the list of all the CF_ environment variables. 
 
 
+### service
+- #### CF_HOST
+  - **description**: The url for reaching you codefresh cluster runtime
+  - required
+  - ["example",["https://codefresh.yourdoamin.com:80"]]
+- #### CF_API_KEY
+  - **description**: Codefresh user token - authenticating with the codefresh runtime.
+  - required
 ### mandatory
 - #### CF_IMAGE
   - **description**: Image name reported
   - required
+  - ["examples",["mydockerhub/pushedimage:fix"]]
 - #### CF_CONTAINER_REGISTRY_INTEGRATION
   - **description**: Registry integration name
-- #### CF_DOCKERHUB_PASSWORD
-  - **description**: When no registry integration is specified: dockerhub token as password
-  - ["examples",["****"]]
-- #### CF_DOCKERHUB_USERNAME
-  - **description**: When no registry integration is specified: dockerhub username
-  - ["examples",["username"]]
-- #### CF_REGISTRY_PASSWORD
-  - **description**: When no registry integration is specified: registry token/password
-  - ["examples",["****"]]
-- #### CF_REGISTRY_USERNAME
-  - **description**: When no registry integration is specified: registry username
-  - ["examples",["username"]]
-- #### CF_REGISTRY_DOMAIN
-  - **description**: When no registry integration is specified: registry domain
-  - ["examples",["quay.com"]]
 - #### CF_ENRICHERS
-  - **description**: List of integrations for collecting metadata on the build image
-- #### CF_REGISTRY_INSECURE
-  - **description**:
-- #### CF_WORKFLOW_NAME
-  - **description**: Given workflow name parameter.
+  - **description**: List of integrations for collecting metadata on the build image, specify blank for no integrated services, by default does both jira and git
+  - ["examples",["jira, git"]]
 - #### CF_WORKFLOW_URL
   - **description**: Reported url of the workflow building the image.
   - ["examples",["https://github.com/saffi-codefresh/csdp-report-image-github-action/actions/runs/2389116616"]]
-- #### CF_LOGS_URL
-  - **description**: Logs url
+- #### CF_WORKFLOW_NAME
+  - **description**: Given workflow name parameter, Optional name to appear on codefresh platform page.
+  - ["examples",["Staging build step"]]
 - #### CF_CI_TYPE
-  - **description**: Name of integration type i.e: git-action
+  - **description**: Name of integration type, used for filtering results by the reporting tool type
+  - ["examples",["git-action","classic","jenkins",""]]
 ### git
 - #### CF_GIT_BRANCH
   - **description**: The git branch which is related for the commit
@@ -66,12 +111,20 @@ For each specific connection (such as jira) parameters can be provided explicitl
   - required
 ### github
 - #### CF_GITHUB_TOKEN
-  - **description**: Github authentication token
+  - **description**: When explicit authentication used: For github use, authenticate with a github-token
   - required
   - ["examples",["ghp_vVvA6oh5iCO...."]]
 - #### CF_GITHUB_API_URL
   - **description**: Specify github host api url
   - ["examples",["https://api.github.com"]]
+### gitlab
+- #### CF_GITLAB_TOKEN
+  - **description**: When explicit authentication used: For gitlab use, authenticate with a gitlab-token
+  - required
+  - ["examples",["glpat-CzJ...."]]
+- #### GITLAB_HOST_URL
+  - **description**: Specify gitlab host url
+  - ["examples",["https://gitlab.com"]]
 ### jira
 - #### CF_JIRA_PROJECT_PREFIX
   - **description**: Jira prefix for identifying the ticket number to use
@@ -85,14 +138,3 @@ For each specific connection (such as jira) parameters can be provided explicitl
   - **description**: Fail pipeline if 'issue' not found
 - #### CF_JIRA_INTEGRATION
   - **description**: When jira integration name is specified instead of providing explicit credentials
-### explicit-jira-setup
-- #### CF_JIRA_API_TOKEN
-  - **description**: When no jira integration is specified: Jira token for authenticating
-  - required
-- #### CF_JIRA_EMAIL
-  - **description**: When no jira integration is specified: user email for authenticating with jira
-  - required
-- #### CF_JIRA_HOST_URL
-  - **description**: When no jira integration is specified: The jira server url
-  - required
-  - ["examples",["https://codefresh-io.atlassian.net"]]