diff --git a/README.md b/README.md index dc9f7ad..048c553 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,27 @@ # Allure Jenkins Plugin -[![release](http://github-release-version.herokuapp.com/github/jenkinsci/allure-plugin/release.svg?style=flat)](https://github.com/jenkinsci/allure-plugin/releases/latest) -[![Build Status](https://ci.qameta.io/buildStatus/icon?job=allure-plugin/master)](https://ci.qameta.io/job/allure-plugin/job/master/) +[![release](https://img.shields.io/github/v/release/jenkinsci/allure-plugin?style=flat)](https://github.com/jenkinsci/allure-plugin/releases/latest) +[![Build Status](https://img.shields.io/github/actions/workflow/status/jenkinsci/allure-plugin/build.yml?branch=master&style=flat)](https://github.com/jenkinsci/allure-plugin/actions/workflows/build.yml?query=branch%3Amaster) + +> This repository contains the source code of the Allure plugin for Jenkins. + +[Allure Report logo](https://allurereport.org "Allure Report") + +- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org) +- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report +- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community +- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates +- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community +- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action ## Getting Started +This plugin allows you to create Allure reports as part of your Jenkins builds. You can then view the generated report directly in Jenkins or download it to your machine. + +To learn more, please visit [the official documentation](https://allurereport.org/docs/integrations-jenkins/). + +## Useful links + * [Issues](https://github.com/jenkinsci/allure-plugin/issues?labels=&milestone=&page=1&state=open) * [Releases](https://github.com/jenkinsci/allure-plugin/releases)