From f3cb77900e112a768a7c5b286c316bc678e64ac6 Mon Sep 17 00:00:00 2001 From: CortexProjectsDepartment <43964841+CortexProjectsDepartment@users.noreply.github.com> Date: Wed, 29 May 2019 14:58:22 +0100 Subject: [PATCH] Update README.md --- README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 67 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e652b8c..8b4059b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,67 @@ -# CTX-Jira-Service-Desk -This module allows users to interact with Jira Service Desk by creating, deleting, updating, resolving and getting details of issues. +# CTX-Jira-Service-Desk Cortex Module + + +The module allows users to perform the following functionality: +* Encrypt Jira username and password +* Create Jira Issue +* Edit Jira Issue +* Get details of Jira issue +* Resolve Jira issue +* Delete Jira issue + +## Table of Contents +1) [Dependencies](#dependencies) + * [Cortex Version](#cortex-version) + * [OCIs](#ocis) + * [Files](#files) + * [Other](#other) +2) [Installation](#installation) +3) [How to use](#how-to-use) +4) [How you can contribute](#how-you-can-contribute) +5) [Versioning](#versioning) +6) [Licensing](#licensing) + + +## Dependencies +### Cortex Version +This version of the CTX-Jira-Service-Desk module was developed in Cortex version 6.5. Some functionality may not be available on different verions of Cortex. + +### Jira Version +This version of the CTX-Jira-Service-Desk module was tested using a server with Jira Service Desk version 8.2.0 installed. Some functionality may not be available on different versions of Jira Service Desk. + +### OCIs +The module requires the following Cortex OCIs: +* PowerShell +* HTTP + +### Files +The CTX-Jira-Service-Desk module requires the following files: +* [CTX-Jira-Service-Desk.studiopkg](https://github.com/CortexIntelligentAutomation/CTX-Jira-Service-Desk-/releases/download/1.0/CTX-Jira-Service-Desk.studiopkg) + +## Installation +Details of the installation can be found in the [CTX-Jira-Service-Desk Deployment Plan](https://github.com/CortexIntelligentAutomation/CTX-Jira-Service-Desk/blob/master/CTX-Jira-Service-Desk%20-%20Deployment%20Plan.pdf). +## How to use +A detailed User Guide has been provided with instructions on how to use the flows/subtasks, available [here](https://github.com/CortexIntelligentAutomation/CTX-Jira-Service-Desk/blob/master/CTX-Jira-Service-Desk-%20-%20User%20Guide.pdf). Configuration of subtask inputs and outputs are detailed in notes on the subtask workspace. + +## How you can contribute +Unfortunately, we cannot offer pull requests at this time or accept any improvements. + +## Versioning +CTX-Jira-Service-Desk-With-Details has the following versions, starting with the most recent: + +## Licensing +All functionality within this module is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). + +Copyright 2019 Cortex Limited + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License.