Skip to content

Commit 9130b84

Browse files
authored
update README.md
1 parent 2881d11 commit 9130b84

File tree

1 file changed

+30
-44
lines changed

1 file changed

+30
-44
lines changed

README.md

Lines changed: 30 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -13,48 +13,48 @@
1313
[![Build](https://github.com/allure-framework/allure-java/actions/workflows/build.yml/badge.svg)](https://github.com/allure-framework/allure-java/actions/workflows/build.yml)
1414
[![Allure Java](https://img.shields.io/github/release/allure-framework/allure-java.svg)](https://github.com/allure-framework/allure-java/releases/latest)
1515

16-
The repository contains new versions of adaptors for JVM-based test frameworks.
16+
> The repository contains new versions of adaptors for JVM-based test frameworks.
1717
18-
All the artifacts are deployed to `https://repo1.maven.org/maven2/io/qameta/allure/`.
18+
[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
1919

20-
## TestNG
21-
22-
The new TestNG adaptors is pretty much ready. To use the adaptor you should add the following dependency:
20+
- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)
21+
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
22+
-[Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
23+
- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates
24+
- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
25+
- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action
2326

24-
```xml
25-
<dependency>
26-
<groupId>io.qameta.allure</groupId>
27-
<artifactId>allure-testng</artifactId>
28-
<version>$LATEST_VERSION</version>
29-
</dependency>
30-
```
27+
---
28+
## TestNG
3129

32-
also you need to configure AspectJ weaver to support steps.
30+
- 🚀 Documentation — https://allurereport.org/docs/testng/
31+
- 📚 Example project — https://github.com/allure-examples?q=topic%3Atestng
32+
- ✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
3333

3434
## JUnit 4
3535

36-
The first draft of a new JUnit 4 adaptor is ready. To use the adaptor you should add the following dependency:
36+
- 🚀 Documentation — work in progress
37+
- 📚 Example project — https://github.com/allure-examples?q=topic%3Ajunit4
38+
- ✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
39+
-
40+
## JUnit 5
3741

38-
```xml
39-
<dependency>
40-
<groupId>io.qameta.allure</groupId>
41-
<artifactId>allure-junit4</artifactId>
42-
<version>$LATEST_VERSION</version>
43-
</dependency>
44-
```
42+
- 🚀 Documentation — https://allurereport.org/docs/junit5/
43+
- 📚 Example project — https://github.com/allure-examples?q=topic%3Ajunit5
44+
- ✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
4545

46-
## JUnit 5
46+
## Cucumber JVM
4747

48-
To use JUnit 5 simply add the following dependency to your project:
48+
- 🚀 Documentation — https://allurereport.org/docs/cucumberjvm/
49+
- 📚 Example project — https://github.com/allure-examples?q=cucumber&type=all&language=java
50+
- ✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
4951

50-
```xml
51-
<dependency>
52-
<groupId>io.qameta.allure</groupId>
53-
<artifactId>allure-junit5</artifactId>
54-
<version>$LATEST_VERSION</version>
55-
</dependency>
56-
```
52+
## Spock
5753

54+
- 🚀 Documentation — https://allurereport.org/docs/spock/
55+
- 📚 Example project — https://github.com/allure-examples?q=topic%3Aspock
56+
- ✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
57+
5858
## Selenide
5959

6060
Listener for Selenide, that logging steps for Allure:
@@ -240,17 +240,3 @@ Usage example:
240240
Awaitility.setDefaultConditionEvaluationListener(new AllureAwaitilityListener());
241241
```
242242

243-
## Cucumber
244-
4,5,6,7 versions are supported instead of N use the required version.
245-
To use Cucumber simply add the following dependency to your project:
246-
247-
[How to use allure cucumber code examples](https://github.com/allure-examples?q=cucumber&type=all&language=java)
248-
249-
```xml
250-
<dependency>
251-
<groupId>io.qameta.allure</groupId>
252-
<artifactId>allure-cucumberN-jvm</artifactId>
253-
<version>$LATEST_VERSION</version>
254-
</dependency>
255-
256-
```

0 commit comments

Comments
 (0)