Skip to content

Commit 978549a

Browse files
committed
Updating readme
1 parent f2dfc1c commit 978549a

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,50 @@ json-report
22
===========
33
[![Build Status](https://app.snap-ci.com/apoorvam/json-report/branch/master/build_image)](https://app.snap-ci.com/apoorvam/json-report/branch/master)
44

5-
JSON reporting for [Gauge](http://getgauge.io)
5+
JSON reporting plugin for [Gauge](http://getgauge.io) as per [JSON Schema](https://apoorvam.github.io/json-report/)
66

77
Install through Gauge
88
---------------------
99

10+
### Install through Gauge
11+
12+
```
13+
gauge --install json-report
14+
```
15+
Installing specific version:
16+
17+
```
18+
gauge --install json-report --plugin-version 0.1.0
19+
```
20+
1021
### Offline installation
1122
* Download the plugin from [Releases](https://github.com/apoorvam/json-report/releases)
1223
```
1324
gauge --install json-report --file <path_to_plugin_zip_file>
1425
```
1526

27+
### Usage
28+
29+
Add this plugin to your Gauge project by registering it in `manifest.json` file. You can also do this by:
30+
31+
```
32+
gauge --add-plugin json-report
33+
```
34+
35+
By default, reports are generated in `reports/json-report` directory of your Gauge project. You can set a custom location by setting the below mentioned property in `default.properties` file of `env/default` directory.
36+
37+
```
38+
#The path to the gauge reports directory. Should be either relative to the project directory or an absolute path
39+
gauge_reports_dir = reports
40+
```
41+
42+
You can also choose to override the reports after each execution or retain all of them as follows.
43+
44+
```
45+
#Set as false if gauge reports should not be overwritten on each execution. A new time-stamped directory will be created on each execution.
46+
overwrite_reports = true
47+
```
48+
1649
Build from Source
1750
-----------------
1851

0 commit comments

Comments
 (0)