added readme

mhristof · Dec 7, 2020 · 68293d5 · 68293d5
1 parent 2385910
commit 68293d5
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+bin/
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# githubactions-docs
+
+Converts a GitHub actions file to markdown documentation in a similar way as [terraform-docs](https://github.com/terraform-docs/terraform-docs) does for terraform.
+
+
+## Usage
+
+```
+githubactions-docs action.yml
+```
+
+
+## Installation
+
+If you have go, then
+
+```
+go get -u github.com/mhristof/githubactions-docs
+```
+
+If you dont, download the latest from the release page.
+
+To update to the latest version, type
+
+```
+githubactions-docs update
+```