Update documentation, version, gha, add sponsors

.github/FUNDING.yml

@@ -0,0 +1,8 @@
+github: [clydedz]
+ko_fi: clydedsouza
+custom:
+  [
+    "https://sponsor.clydedsouza.net/",
+    "https://paypal.me/clydedz",
+    "https://www.revolut.me/clydedz/",
+  ]

.github/workflows/npm.yml

@@ -5,12 +5,12 @@ on:
     branches:
       - main
     paths-ignore:
-      - README.md
+      - "docs/**"
   pull_request:
     branches:
       - main
     paths-ignore:
-      - README.md
+      - "docs/**"
 
 jobs:
   build_publish:

.npmignore

@@ -1,4 +1,13 @@
 .netlify/**
+.github/**
+
 .env*
+*.tgz
+
+
+netlify.toml
+
+docs/**  
+coverage/**
 
-netlify.toml
+src/**.test.**

README.md

@@ -36,6 +36,10 @@ Note:
 - Netlify will automatically populate `COMMIT_REF` with the GitHub commit hash. No action required on this.
 - When creating the GitHub token, add the "read and write" permissions for "Commit statuses" for this token. This token must be associated with the repository given in the `GITHUB_REPO_NAME` environment variable.
 
+Run the Netlify build and deploy process for a commit pushed to the GitHub repository. Then head to the commit in GitHub and you should see the commit status reflected, example screenshot below. Note, commit status will be published when a Netlify build begins, when it succeeds and when it fails.
+
+![image info](./docs/demo.png)
+
 ## Credits
 
 Developed by [Clyde D'Souza](https://clydedsouza.net/)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clydedsouza/netlify-plugin-github-deploy-status",
-  "version": "0.0.5-beta.2",
+  "version": "0.0.5-beta.3",
   "description": "Netlify plugin that updates GitHub commit status with the latest deployment progress.",
   "main": "./src/index.cjs",
   "exports": "./src/index.cjs",