Update readme

Add info about available inputs.
test-room-7 · Dec 9, 2019 · 07d7473 · 07d7473
1 parent 48bb669
commit 07d7473
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,23 @@ jobs:
         github-token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+## Inputs
+
+### Required inputs
+
+- `commit-msg`: a text used as a commit message
+- `file-path`: a path to file to be updated
+- `github-token`: GitHub token
+
+### Optional inputs
+
+- `branch`: branch to push changes (`master` by default)
+- `allow-removing`: allow to remove file if local copy is missing
+  (`false` by default)
+
+Note that the action will produce an error iflocal copy is missing,
+and the `allow-removing` flag is `false`.
+
 ## License
 
 See the [license file][License].