add README

Author: Enda Phelan

README.md

@@ -0,0 +1,29 @@
+# install-git-chglog
+
+This action installs [git-chglog](https://pkg.go.dev/github.com/git-chglog/git-chglog?utm_source=godoc) and adds it to your PATH.
+
+## Usage
+
+See [action.yaml](https://github.com/actions/setup-go/blob/main/action.yml)
+
+Basic:
+
+```yaml
+steps:
+- uses: actions/install-git-chglog@v0
+  with:
+    version: 'v0.14.0' # The git-chglog version to use
+- run: git-chglog -o CHANGELOG.md
+```
+
+## License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE).
+
+## Contributions
+
+Are welcome.
+
+## Limitations
+
+This will only run on `ubuntu`, so there is no point in passing anything to `runs-on`. I did not see a need to add this, but if you have this use case please reach out via an issue or PR.

action.yml

@@ -1,4 +1,4 @@
-name: 'git-chglog action'
+name: 'install-git-chglog'
 description: 'GitHub Action for git-chglog. Anytime, anywhere, Write your CHANGELOG.'
 author: 'craicoverflow'
 branding:

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "git-chglog-action",
+  "name": "install-git-chglog",
   "description": "GitHub Action for git-chglog",
   "version": "0.1.0",
   "main": "lib/main.js",