doc: create readme

mikeal · Aug 19, 2019 · 8ba5380 · 8ba5380
1 parent 213abdb
commit 8ba5380
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# `publish-to-github-action`
+
+A GitHub Action to push any local file changes, including new files, back to master.
+
+This action is useful to put *after* other actions that modify files in the local checkout
+that you'd then like to persist back into the repository.
+
+Usage:
+
+```
+- uses: mikeal/publish-to-github-action@master
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```