Skip to content

Commit 25e86b5

Browse files
committed
[feature] Make README.md consistent with other plugins.
1 parent a2056c5 commit 25e86b5

2 files changed

Lines changed: 23 additions & 2 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ bin
44
.settings
55
.project
66
.classpath
7+
*.iml

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
1-
# jqa-kieker-plugin
1+
# jQAssistant Kieker Plugin
22

33
[![GitHub license](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://github.com/softvis-research/jqa-kieker-plugin/blob/master/LICENSE)
44
[![Build Status](https://travis-ci.com/softvis-research/jqa-kieker-plugin.svg?branch=master)](https://travis-ci.com/softvis-research/jqa-kieker-plugin)
55

6-
This is a stack trace parser for jQAssistant. It enables jQAssistant to scan and to analyze [Kieker](https://github.com/kieker-monitoring/kieker) trace event logs.
6+
This is a [Kieker](https://github.com/kieker-monitoring/kieker) stack trace parser for [jQAssistant](https://jqassistant.org/).
7+
It enables jQAssistant to scan and to analyze data from [Kieker](https://github.com/kieker-monitoring/kieker).
8+
9+
## Getting Started
10+
11+
Download the jQAssistant command line tool for your system: [jQAssistant - Get Started](https://jqassistant.org/get-started/).
12+
13+
Next download the latest version from the release tab. Put the `jqa-kieker-plugin-*.jar` into the plugins folder
14+
of the jQAssistant commandline tool.
15+
16+
Now scan your configuration and wait for the plugin to finish:
17+
18+
```bash
19+
jqassistant.sh scan -f
20+
```
21+
22+
You can then start a local Neo4j server to start querying the database at [http://localhost:7474](http://localhost:7474):
23+
24+
```bash
25+
jqassistant.sh server
26+
```

0 commit comments

Comments
 (0)