Merge pull request #16 from rhythmictech/update-readme

add stuff to readme
rhythmictech · Jun 26, 2022 · 1597dfa · 1597dfa
2 parents ef7570b + f3eabff
commit 1597dfa
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,20 @@
+[![Check dist/](https://github.com/rhythmictech/actions-setup-tfenv/actions/workflows/check-dist.yml/badge.svg)](https://github.com/rhythmictech/actions-setup-tfenv/actions/workflows/check-dist.yml)
+[![CodeQL](https://github.com/rhythmictech/actions-setup-tfenv/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/rhythmictech/actions-setup-tfenv/actions/workflows/codeql-analysis.yml)
+[![build-test](https://github.com/rhythmictech/actions-setup-tfenv/actions/workflows/test.yml/badge.svg)](https://github.com/rhythmictech/actions-setup-tfenv/actions/workflows/test.yml)
+
 # Setup Tfenv
+
+Set up your GitHub Actions workflow with tfenv
+
+## Usage
+
+```
+name: Terrafy with tfenv
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: rhythmictech/[email protected]
+```