Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc #1

Merged
merged 1 commit into from
Jan 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 7 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,19 @@
# Deprecation Notice
# Basic info
- Html report that works with [Deque.AxeCore.Selenium](https://www.nuget.org/packages/Deque.AxeCore.Selenium)
- This is package will be deprecated once https://github.com/microsoft/html-reporter-for-axe-core-dotnet is released to Nuget.

### Why is this project being deprecated?
- Deque is officially taking on the .Net bindings
- https://github.com/dequelabs/axe-core-nuget
- https://www.nuget.org/packages/Deque.AxeCore.Selenium/
### Is this a good thing?
- Yes
- TWP.Selenium.Axe actually uses Deque’s Axe core under the hood
- This should help keep the .Net bindings at feature parity with the other official supported binding, such as Java and JavaScript
### What will be happening?
- Upgrade instructions will be provided early in 2023
- This project will be archived
- The NuGet package will be deprecated and https://www.nuget.org/packages/Deque.AxeCore.Selenium/ will be set as the alternate package
### Anything special we should know?
- The new Deque project will support both Selenium and Playwright
- A new project (https://github.com/microsoft/html-reporter-for-axe-core-dotnet) will be used for creating HTML reports. This should provide a much better user experience than the admittedly primitive reporting currently included in TWP.Selenium.Axe

# TWP.Selenium.Axe for .NET
[![TWP.Selenium.Axe NuGet package](https://img.shields.io/nuget/v/TWP.Selenium.Axe)](https://www.nuget.org/packages/TWP.Selenium.Axe)
# TWP.Selenium.Axe.Html for .NET
[![NuGet package download counter](https://img.shields.io/nuget/dt/TWP.Selenium.Axe)](https://www.nuget.org/packages/TWP.Selenium.Axe.Html/)
[![Main pipeline](https://github.com/TroyWalshProf/SeleniumAxeHtmlDotnet/actions/workflows/mainPipeline.yml/badge.svg?branch=main)](https://github.com/TroyWalshProf/SeleniumAxeHtmlDotnet/actions/workflows/mainPipeline.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=TroyWalshProf_SeleniumAxeDotnet&metric=alert_status)](https://sonarcloud.io/dashboard?id=TroyWalshProf_SeleniumAxeDotnet)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=TroyWalshProf_SeleniumAxeDotnet&metric=coverage)](https://sonarcloud.io/dashboard?id=TroyWalshProf_SeleniumAxeDotnet)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=TroyWalshProf_SeleniumAxeDotnet&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=TroyWalshProf_SeleniumAxeDotnet)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=TroyWalshProf_SeleniumAxeHtmlDotnet&metric=alert_status)](https://sonarcloud.io/dashboard?id=TroyWalshProf_SeleniumAxeHtmlDotnet)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=TroyWalshProf_SeleniumAxeHtmlDotnet&metric=coverage)](https://sonarcloud.io/dashboard?id=TroyWalshProf_SeleniumAxeHtmlDotnet)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=TroyWalshProf_SeleniumAxeHtmlDotnet&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=TroyWalshProf_SeleniumAxeHtmlDotnet)


Automated web accessibility testing with .NET, C#, and Selenium. Wraps the [axe-core](https://github.com/dequelabs/axe-core) accessibility scanning engine and the [Selenium.WebDriver](https://www.seleniumhq.org/) browser automation framework.

Compatible with .NET Standard 2.0+, .NET Framework 4.7.1+, and .NET Core 2.0+.

Inspired by [axe-selenium-java](https://github.com/dequelabs/axe-selenium-java) and [axe-webdriverjs](https://github.com/dequelabs/axe-webdriverjs).

## Documentation

* [Getting Started](https://troywalshprof.github.io/SeleniumAxeHtmlDotnet/#/?id=getting-started)
Expand Down
Loading