diff --git a/README.md b/README.md index 4240f39..7642e33 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # xlr-qtest-plugin -This plugin offers an interface from XL Release to QA Symphony qtest API. +This plugin offers an interface from XL Release to QA Symphony qtest API. # CI status # [![Build Status][xlr-qtest-plugin-travis-image]][xlr-qtest-plugin-travis-url] [![Codacy Badge][xlr-qtest-plugin-codacy-image] ][xlr-qtest-plugin-codacy-url] [![Code Climate][xlr-qtest-plugin-code-climate-image] ][xlr-qtest-plugin-code-climate-url] +[![License: MIT][xlr-qtest-plugin-license-image] ][xlr-qtest-plugin-license-url] [xlr-qtest-plugin-travis-image]: https://travis-ci.org/xebialabs-community/xlr-qtest-plugin.svg?branch=master [xlr-qtest-plugin-travis-url]: https://travis-ci.org/xebialabs-community/xlr-qtest-plugin @@ -14,6 +15,8 @@ This plugin offers an interface from XL Release to QA Symphony qtest API. [xlr-qtest-plugin-codacy-url]: https://www.codacy.com/app/amitmohleji/xlr-qtest-plugin [xlr-qtest-plugin-code-climate-image]: https://codeclimate.com/github/xebialabs-community/xlr-qtest-plugin/badges/gpa.svg [xlr-qtest-plugin-code-climate-url]: https://codeclimate.com/github/xebialabs-community/xlr-qtest-plugin +[xlr-qtest-plugin-license-image]: https://img.shields.io/badge/License-MIT-yellow.svg +[xlr-qtest-plugin-license-url]: https://opensource.org/licenses/MIT # Development # @@ -24,9 +27,9 @@ This plugin offers an interface from XL Release to QA Symphony qtest API. + `qtest.Login`: This task uses the provided credentials to login first time and get an OAuth token which is recieved as an output variable of type password. It can then be passed to other tasks for avoiding re-authentication + `qtest.AddComment`: This task allows you to search for objects of any type under a project and then put a comment on those objects. You can use the data Query from qtest web interface + `qtest.CreateTestCase` : This task allows you to add a new test case under a project. You can specify field properties by identifying the field Ids in your installation. You can also provide test steps with description and expected criteria - + # Usage # - + * Setup the server configuration ![](serverConfig.png) @@ -40,4 +43,3 @@ This plugin offers an interface from XL Release to QA Symphony qtest API. # References # [QA Symphony's qtest API](https://support.qasymphony.com/hc/en-us/articles/201615649-qTest-API-v3-Specification) -