Update README.md

README.md

@@ -1,6 +1,7 @@
 # gh-action-jira-create
 
-Use [GitHub actions](https://docs.github.com/en/actions) to create a Jira ticket with customisable fields.
+Use [GitHub actions](https://docs.github.com/en/actions) to create Jira tickets whenever an issue or pull request is created.
+Supports arbitrary additional fields in the API call to Jira.
 
 ## Authentication
 
@@ -13,10 +14,10 @@ Alternatively, you can set some environment variables:
 
 ## Inputs
 
-- `project` - The project key to create the issue in, e.g. `FOO`
-- `issuetype` - The issue type for the ticket, e.g. `Bug`
-- `summary` - The title of the issue, e.g. `A summary`
-- `description` - The body of the issue, e.g. `A description of the issue`
+- `project` (required) - The project key to create the issue in, e.g. `'TEST'`
+- `issuetype` (required) - The issue type for the ticket, e.g. `'Bug'`
+- `summary` (required) - The title of the issue, e.g. `'A summary'`
+- `description` (required) - The body of the issue, e.g. `'A description of the issue'`
 - `extraFields` - A JSON map as a string, specifying any additional fields to set in the create issue payload. See the [Jira REST API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-post) for more details of the available fields, e.g. `'{"parent": {"key": "FOO-23"}, "labels": ["github", "bug"], "customfield_10071": "from-github-action"}'`
 
 ## Outputs
@@ -25,6 +26,8 @@ Alternatively, you can set some environment variables:
 
 ## Examples
 
+The following examples are valid `steps` for a particular job in a workflow; to see how to integrate them into a fully worked example, refer to the [documentation](https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow).
+
 Using `atlassian/gajira-login` and [GitHub secrets](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) for authentication:
 
 ```yaml
@@ -37,7 +40,7 @@ Using `atlassian/gajira-login` and [GitHub secrets](https://docs.github.com/en/a
 
 - name: Create
   id: create
-  uses: tomhjp/[email protected].0
+  uses: tomhjp/[email protected].3
   with:
     project: FOO
     issuetype: "Bug"
@@ -53,7 +56,7 @@ Using environment variables for authentication, and the `github` context to popu
 ```yaml
 - name: Create
   id: create
-  uses: tomhjp/[email protected].0
+  uses: tomhjp/[email protected].3
   with:
     project: FOO
     issuetype: "Bug"