Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matcdac authored Nov 27, 2023
1 parent aac108d commit 76119d9
Showing 1 changed file with 30 additions and 11 deletions.
41 changes: 30 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,19 @@ JBehave JUnit Integration

![Visit Count](https://profile-counter.glitch.me/TurquoiseSpace_jbehave-junit-runner/count.svg)

[![jbehave-junit-runner CI](https://github.com/TurquoiseSpace/jbehave-junit-runner/actions/workflows/ci.yml/badge.svg)](https://github.com/TurquoiseSpace/jbehave-junit-runner/actions/workflows/ci.yml)
[![Java Doc](https://javadoc.io/badge2/com.github.TurquoiseSpace/jbehave-junit-runner/javadoc.svg)](https://javadoc.io/doc/com.github.TurquoiseSpace/jbehave-junit-runner)
[![GitHub (All Releases)](https://img.shields.io/github/downloads/TurquoiseSpace/jbehave-junit-runner/total?color=blue)](https://repo1.maven.org/maven2/com/github/TurquoiseSpace/jbehave-junit-runner/)
[![GitHub (Latest Release)](https://img.shields.io/github/downloads/TurquoiseSpace/jbehave-junit-runner/3.0.0/total)](https://repo1.maven.org/maven2/com/github/TurquoiseSpace/jbehave-junit-runner/3.0.0/)

[![Maven Central](https://img.shields.io/maven-central/v/com.github.TurquoiseSpace/jbehave-junit-runner.svg?label=Maven%20Central)](https://repo1.maven.org/maven2/com/github/TurquoiseSpace/jbehave-junit-runner/)
[![Sonatype Central Search](https://img.shields.io/maven-central/v/com.github.TurquoiseSpace/jbehave-junit-runner.svg?label=Sonatype%20Central%20Search)](https://central.sonatype.com/search?q=jbehave-junit-runner&namespace=com.github.TurquoiseSpace)
[![Sonatype Central Artifact](https://img.shields.io/maven-central/v/com.github.TurquoiseSpace/jbehave-junit-runner.svg?label=Sonatype%20Central%20Artifact)](https://central.sonatype.com/artifact/com.github.TurquoiseSpace/jbehave-junit-runner)
[![MVN Repository](https://img.shields.io/maven-central/v/com.github.TurquoiseSpace/jbehave-junit-runner.svg?label=MVN%20Repository)]([https://repo1.maven.org/maven2/com/github/TurquoiseSpace/jbehave-junit-runner/](https://mvnrepository.com/artifact/com.github.TurquoiseSpace/jbehave-junit-runner))

[![jbehave-junit-runner CI](https://github.com/TurquoiseSpace/jbehave-junit-runner/actions/workflows/ci.yml/badge.svg)](https://github.com/TurquoiseSpace/jbehave-junit-runner/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/TurquoiseSpace/jbehave-junit-runner/badge.svg?branch=master)](https://coveralls.io/github/TurquoiseSpace/jbehave-junit-runner?branch=master)
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=TurquoiseSpace_jbehave-junit-runner&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=TurquoiseSpace_jbehave-junit-runner)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d81f58136aa245668240b7d851a54d50)](https://www.codacy.com/gh/TurquoiseSpace/jbehave-junit-runner/dashboard?utm_source=github.com&utm_medium=referral&utm_content=TurquoiseSpace/jbehave-junit-runner&utm_campaign=Badge_Grade)

[![Maven Central](https://img.shields.io/maven-central/v/com.github.TurquoiseSpace/jbehave-junit-runner.svg)](https://central.sonatype.com/search?q=jbehave-junit-runner&namespace=com.github.TurquoiseSpace)
[![Javadocs](http://www.javadoc.io/badge/com.github.TurquoiseSpace/jbehave-junit-runner.svg)](http://www.javadoc.io/doc/com.github.TurquoiseSpace/jbehave-junit-runner)
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=TurquoiseSpace_jbehave-junit-runner&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=TurquoiseSpace_jbehave-junit-runner)
[![Known Vulnerabilities](https://snyk.io/test/github/TurquoiseSpace/jbehave-junit-runner/badge.svg?targetFile=pom.xml)](https://snyk.io/test/github/TurquoiseSpace/jbehave-junit-runner?targetFile=pom.xml)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/TurquoiseSpace/jbehave-junit-runner/master/LICENSE)
Expand All @@ -29,6 +34,15 @@ The project consists of only a handful of classes
and is easy to use.


Using Java
-------------------
Minimum JDK / Java SE Support : 11
Compiled as Class File Major Version : 55

Refer the Table
https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.1-200-B.2


Using Maven
-------------------
The easiest way is to include
Expand All @@ -44,9 +58,9 @@ all available from Maven Central.
</dependency>
```

Note that the JBehave library is set to scope `provided`
in the POM, because any project using this Runner will
naturally have their own version of JBehave already.
Note that the JBehave library is NOT set to scope `provided` in the POM
different from earlier versions published under valfirst/jbehave-junit-runner
because any project using this Runner will naturally have their own version of JBehave already.

Current development SNAPSHOT versions are available from
[Sonatype's Nexus for Open Source projects](https://oss.sonatype.org/content/repositories/snapshots/com/github/TurquoiseSpace/jbehave-junit-runner/).
Expand All @@ -59,10 +73,15 @@ add the library to your classpath.
Also make sure you add the dependencies of this library to the classpath as well. They can be
seen in the `pom.xml`. For convenience, they are listed here, too:

* jbehave-core (4.1+)
* junit (4.12)
* jbehave-core (5.2.0)
* junit (5.10.1)

Below dependencies are set with test scope

* mockito (5.7.0)
* hamcrest (2.2)

Your project will of course have JBehave already, just make sure it is version 4.1 or above.
Your project will of course have JBehave already, just make sure it is version 5.2.0 or above.


Usage
Expand Down

0 comments on commit 76119d9

Please sign in to comment.