Improved documentation and renamed workflow

wictorwilen · May 24, 2020 · aadcce7 · aadcce7
1 parent b934dae
commit aadcce7
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/.github/workflows/test.yml → .github/workflows/verification.yml b/.github/workflows/test.yml → .github/workflows/verification.yml
diff --git a/README.md b/README.md
@@ -4,6 +4,14 @@ A Github Action that creates Deployment annoations in Application Insights
 
 ![.github/workflows/test.yml](https://github.com/wictorwilen/application-insights-action/workflows/.github/workflows/test.yml/badge.svg)
 
+This action allows you to add annotations to the Application Insights timeline so that you with ease can correlate any issues or changes to specific deployments.
+
+![Annotation sample](assets/annotation-sample.jpg)
+
+## Setup
+
+You need the *Application Id* for your Application Insights instance as well as an *API key*. These values are found in the *API Access* tab. The *API key* is created by selecting *Create API key* and then typing a description and selecting *Write Annotations*. After selecting *Generate key* you will get the generated *API key*. It is strongly recommended to add these two as [Github secrets](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) and not reference them directly in your workflow.
+
 ## Inputs
 
 The action accepts the following inputs:
@@ -17,7 +25,7 @@ The action accepts the following inputs:
 ## Sample configuration
 
 ``` yaml
-- name: Annotation
+- name: Annotate deployment
   uses: wictorwilen/application-insights-action@v1
   id: annotation
   with:

diff --git a/assets/annotation-sample.jpg b/assets/annotation-sample.jpg