From 605abca600cf28d6eae40d1041d18202835a967e Mon Sep 17 00:00:00 2001
From: Maksim Milykh <maksim_milykh@epam.com>
Date: Fri, 20 Nov 2020 11:49:40 +0300
Subject: [PATCH] - Update README - Cosmetic changes

---
 .github/workflows/test.yml |  4 ++--
 README.md                  | 42 +++++++++++++++++++++++++++++++++++++-
 2 files changed, 43 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index db8f3e7..78a6adb 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -1,7 +1,7 @@
 on: [push]
 
 jobs:
-  hello_world_job:
+  structurizr-cli:
     runs-on: ubuntu-latest
     name: Run structurizr-cli
     steps:
@@ -9,7 +9,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Hello world action step
+      - name: Run structurizr-cli action
         uses: ./
         id: test
         with:
diff --git a/README.md b/README.md
index b3bf9b3..3c64350 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,41 @@
-# structurizr-cli-action
\ No newline at end of file
+# Structurizr-cli Action
+
+This action allows you to run `structurizr-cli`.
+
+## Usage
+
+To use the action simply create an `structurizr-cli.yml` (or choose custom `*.yml` name) in the `.github/workflows/` directory.
+
+For example:
+
+```yaml
+name: sctructurizr-cli  # feel free to pick your own name
+
+on: [push, pull_request]
+
+jobs:
+  structurizr-cli:
+    runs-on: ubuntu-latest
+    name: Run structurizr-cli
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Run structurizr-cli action
+        uses: actions/structurizr-cli-action
+        id: test
+        with:
+          id: # required
+          key: # required
+          secret: # required
+          workspace: # required
+```
+
+## License
+
+The Dockerfile and associated scripts and documentation in this project are released under the [MIT](license).
+
+## Credits
+
+The initial GitHub action has been created by [Maksim Milykh](https://github.com/aidmax).