Add documentation (#14)

Author: kellertk

CONTRIBUTING.md

@@ -32,9 +32,10 @@ To send us a pull request, please:
 1. Fork the repository.
 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
 3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+4. Make sure you run `yarn package`! GitHub expects the runnable action code to exist in dist/
+5. Commit to your fork using clear commit messages.
+6. Send us a pull request, answering any default questions in the pull request interface.
+7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
 GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

README.md

@@ -1,11 +1,31 @@
-## My Project
+# Pull Request Exclusion Action for GitHub Actions
 
-TODO: Fill this README out!
+Sometimes, you don't want to accept pull requests on GitHub against some parts
+of your code. This GitHub action accepts a regular expression as an argument,
+and if your repository receives a pull request with a pathspec that matches,
+the pull request will be automatically closed with a message.
 
-Be sure to:
+## Building and testing
 
-* Change the title in this README
-* Edit your repository description on GitHub
+Install dependencies
+```bash
+$ yarn install
+```
+
+Build and test
+```bash
+$ yarn run all
+```
+## Usage
+
+You need to add a workflow file into your repository under
+[.github/workflows](./.github/workflows), just like any other Github Action.
+This workflow file [follows the standard workflow syntax for Github Actions.](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions).
+
+A sample workflow file for you to use as a drop-in is in [sample_workflow.yml](./sample_workflow.yml).
+
+**NOTE:** For stability, you should use the action with either an
+explicit tag, or commit SHA:
 
 ## Security
 

sample_workflow.yml

@@ -0,0 +1,17 @@
+name: "Check for unacceptable PR"
+on:
+  pull_request:
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: aws-actions/pr-regex-exclude@<commit_sha>
+        with:
+          exclude-regex: '<your JS RegEx syntax here>'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          message: |
+                   Thank you for submitting this PR, but it appears that at least one file in this
+                   request is against a part of our codebase that does not accept pull requests.
+                   Please check the [contributing guide](./CONTRIBUTING.md) for more information.
+                   I am a bot; this action was performed automatically.