Skip to content

fix(plugin-axe): update plugin name references in README #1143

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.

Sign up for GitHub

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

Merged
hanna-skryl merged 1 commit into from
Nov 13, 2025
Merged

fix(plugin-axe): update plugin name references in README #1143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions packages/plugin-axe/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# @code-pushup/plugin-axe
# @code-pushup/axe-plugin

[![npm](https://img.shields.io/npm/v/%40code-pushup%2Faxe-plugin.svg)](https://www.npmjs.com/package/@code-pushup/axe-plugin)
[![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Faxe-plugin)](https://npmtrends.com/@code-pushup/axe-plugin)
[![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup/axe-plugin)](https://www.npmjs.com/package/@code-pushup/axe-plugin?activeTab=dependencies)

🕵️ **Code PushUp plugin for automated accessibility testing with Axe.** 🌐

Expand All @@ -15,23 +19,23 @@ The plugin runs accessibility audits on web pages using [axe-core](https://githu
2. Install as a dev dependency with your package manager:

```sh
npm install --save-dev @code-pushup/plugin-axe
npm install --save-dev @code-pushup/axe-plugin
```

```sh
yarn add --dev @code-pushup/plugin-axe
yarn add --dev @code-pushup/axe-plugin
```

```sh
pnpm add --save-dev @code-pushup/plugin-axe
pnpm add --save-dev @code-pushup/axe-plugin
```

3. Add this plugin to the `plugins` array in your Code PushUp CLI config file (e.g. `code-pushup.config.ts`).

Pass in the URL you want to test:

```ts
import axePlugin from '@code-pushup/plugin-axe';
import axePlugin from '@code-pushup/axe-plugin';

export default {
// ...
Expand Down