From 63ba9cc8f3655925467b894a02ad7041a7163fbe Mon Sep 17 00:00:00 2001 From: gabriel pita Date: Mon, 15 Jan 2024 15:15:51 -0300 Subject: [PATCH] improve README.md copy paste improve README.md copy paste --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d7dae20..d1149ea 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,16 @@ Installation If you already have [Python](https://www.python.org/) and [pip](https://pip.pypa.io) installed, you can simply run the command below in your terminal. We recommend using **Python 3.10** or newer. ``` -$ pip install trcli +pip install trcli ``` To verify the installation was successful, you can run the `trcli` command. ```shell -$ trcli +trcli +``` +You should get something like this: +``` TestRail CLI v1.8.0 Copyright 2023 Gurock Software GmbH - www.gurock.com Supported and loaded modules: @@ -38,7 +41,9 @@ Supported and loaded modules: CLI general reference -------- ```shell -$ trcli --help +trcli --help +``` +```shell TestRail CLI v1.8.0 Copyright 2023 Gurock Software GmbH - www.gurock.com Usage: trcli [OPTIONS] COMMAND [ARGS]... @@ -83,7 +88,9 @@ In the next sections you will find information on how to use the TestRail CLI fo ### Reference ```shell -$ trcli parse_junit --help +trcli parse_junit --help +``` +```shell Usage: trcli parse_junit [OPTIONS] Parse report files and upload results to TestRail @@ -248,7 +255,9 @@ providing you with a solid base of test cases, which you can further expand on T ### Reference ```shell -$ trcli parse_openapi --help +trcli parse_openapi --help +``` +```shell TestRail CLI v1.5.0 Copyright 2021 Gurock Software GmbH - www.gurock.com Usage: trcli parse_openapi [OPTIONS]