chore: update the README

README.md

@@ -1,2 +1,35 @@
-# Okami
-GitHub action to post animal images/gifs on PRs
+# Okami action
+
+This actions adds a random image of an animal to your PR every time it is run.
+
+## Inputs
+
+### `okami-token`
+
+**Required** Token with access to post on the PR.
+
+### `animal-type`
+
+The animal type to post a picture of.
+Choices are:
+
+- `shiba`
+- `cat`
+- `bird`
+- `fox`
+- `dog`
+
+Defaults to `shiba`
+
+## Example usage
+
+```yaml
+uses: actions/okami-action@v1
+with:
+  okami-token: ${{ secrets.GITHUB_TOKEN }
+  animal-type: "shiba"
+```
+
+## Development
+
+Run `ncc build index.js --license licenses.txt` before commiting files.