diff --git a/README.md b/README.md new file mode 100644 index 0000000..adc9ef6 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Enforce Pull Request Description Length Action + +This action checks that a Pull Request Description is at a minimum length. By default the minimum length is one. If a different minimum length is needed it can be passed in using an Action Input. + +## Inputs + +### `minLength` + +A specific minimum length the description must be. + +## Example Usage + +``` +- name: Enforce Jira Issue Key in Pull Request Title + uses: ryanvade/enforce-pr-description-length-action@v1 +``` + +## Example Usage with a specific min length + +``` +- name: Enforce Jira Issue Key in Pull Request Title + uses: ryanvade/enforce-pr-description-length-action@v1 + with: + minLength: 5 +``` \ No newline at end of file