From 6219de5d10b3205f0b41215bdf51a01b89bd8a1b Mon Sep 17 00:00:00 2001
From: Ryan Owens <RyanOwens@linux.com>
Date: Fri, 11 Dec 2020 12:23:59 -0600
Subject: [PATCH] added README.md

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a8a0b19
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# Enforce Pull Request Title Style Action
+
+This action analyses the titles of Pull Requests to ensure they start with a Jira Issue Key.  Issue Keys are a combination of a Project Key, a hyphen, and a number designating which issue it is.  In general, Project Keys are two capital letters but Jira does allow for [custom Project Keys](https://confluence.atlassian.com/adminjiraserver/changing-the-project-key-format-938847081.html) and this issue attempts to abide by the custom format. 
+
+For example, if your project key were `AB` then the following would be allowed
+
+```
+AB-1  Initialize Project
+```
+
+However, the following examples would not be allowed
+
+```
+aB-1 Initialize Project
+```
+
+```
+ab-1 Initialize Project
+```
+
+```
+Ab 1 Initialize Project
+```
+
+Valid Pull Request titles must also include a short description after the Issue Key. Therefore the following is not valid. 
+
+```
+AB-1
+```
+
+By default, this action will allow any valid Issue Key so long as it *could* be valid. If you want to be specific to your project, use the `projectKey` input for the action. 
+
+## Inputs
+
+### `projectKey`
+
+A specific Project Key to always check for. 
+
+## Example Usage
+
+```
+- name: Enforce Jira Issue Key in Pull Request Title
+  uses: ryanvade/enforce-pr-title-style-action@v1
+```
+
+## Example Usage with a specific Project Key
+
+```
+- name: Enforce Jira Issue Key in Pull Request Title
+  uses: ryanvade/enforce-pr-title-style-action@v1
+  with:
+    projectKey: AB
+```
\ No newline at end of file