Skip to content

Commit

Permalink
docs: update readme (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
karnett authored May 21, 2024
1 parent 5ba1411 commit 31040ca
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
# axe-devtools-ios
# axe DevTools for Mobile by Deque Systems

Start scanning for accessibility issues today with the axe DevTools for iOS frameworks.
Start scanning for accessibility issues in your automated tests!

Embed directly or utilize Swift Package Manager to pull in axeDevToolsUIKit and/or axeDevToolsXCUI.

## Swift Package Manager

In Xcode, open your main project settings, then select the tab for `Package Dependencies`.
## Documentation

Under Packages, select the + icon to add a dependency.
### Automation
This framework is for automated testing in a UI Test environment. Follow our [getting started guide](https://docs.deque.com/devtools-mobile/xcui) to start embedding accessibility testing thoroughout your iOS project.

For URL, insert this repo: https://github.com/dequelabs/axe-devtools-ios
Then select branch -> main to always get the latest available versions. To stick with a specific version, please use the commit setting and find the version you'd like to add via tags.
Looking for other solutions? Checkout the [full axe DevTools for Mobile suite](https://www.deque.com/axe/devtools/mobile-accessibility/)

## Usage

To use axe DevTools, you must be a current Deque customer or have an active free trial membership for the mobile product.

## Documentation

In addition to the included doccarchive files, find documentation for axe DevTools Mobile including features and rule information at [docs.deque.com](https://docs.deque.com/).
To use axe DevTools, you must be a current Deque customer or have an [active free trial membership for the mobile product](https://www.deque.com/axe/devtools/mobile-accessibility/).

0 comments on commit 31040ca

Please sign in to comment.