Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippRecke authored Dec 6, 2023
1 parent 67e97c4 commit 1b11b34
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# Autocomplete-Check
This is a browser-plugin for testing Websites against WCAG 2.1 Success Criterion 1.3.5: Identify Input Purpose.
This is a Chrome plugin for testing Websites against WCAG 2.1 Success Criterion 1.3.5: Identify Input Purpose.

![example markers](./docu/exampleBadges.png)

## How to use
1. pin the plugin to your browser-toolbar
2. click the plugin-icon to enable the extension
1. pin the installed plugin to your browser-toolbar
2. click the plugin icon to enable the extension

## Build and Run
You may skip building the plugin yourself, by downloading the shipped "/dist"-folder and skipping the first two steps.
1. run `npm run build`
2. output will be saved in "/dist"-folder
3. open Chrome-Browser
4. go to "chrome://extensions"
5. enable Developer mode (witch at top right)
5. enable Developer mode (switch at top right)
6. click "Load unpacked" and select "/dist"-folder


## Setup-Development-Environment
## Setup Development-Environment
1. clone repo
2. make sure TypeScript is installed
3. run `npm install`

0 comments on commit 1b11b34

Please sign in to comment.