add readme

AGraber · Sep 9, 2020 · face9c9 · face9c9
1 parent 4ba95e2
commit face9c9
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# sampctl-action
+This action sets up sampctl in the environment for use in actions.
+
+This doesn't work on Windows (no reason to use Windows anyways, output is the same).
+
+# Usage
+Basic example:
+
+```yml
+steps:
+  - uses: actions/checkout@v2
+  - uses: AGraber/sampctl-action@v1
+      with:
+      version: '1.9.1' # optional, 1.9.1 by default
+  - run: sampctl p build --forceEnsure
+```