Skip to content

Commit

Permalink
Added more getting started instructions to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
quittle committed May 28, 2019
1 parent 6f49133 commit 9173777
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
9 changes: 9 additions & 0 deletions GETTING_STARTED.md
@@ -0,0 +1,9 @@
# Getting Started

**Step 1: Install A11y Ally.** You can find A11y Ally [here on the Google Play store](https://play.google.com/store/apps/details?id=com.quittle.a11yally).

**Step 2: Grant A11y Ally permissions.** A11y Ally requires the "Draw over other apps" permission on Android Marshmallow and later. It must also be enabled as an accessibility service. When you first open the app, you will be guided through this set up.

**Step 3: Explore the filters.** A11y Ally currently supports 3 filter modes. Turn on the first one, "Highlight Issues", by tapping the switch. Once enabled, select "Accessibility Issue Playground" and observe the errors highlighted.

**Step 4: Try it on your own app!** After exploring the filters in the playground, try them out on your own app and see what issues you can find.
4 changes: 3 additions & 1 deletion README.md
@@ -1,13 +1,15 @@
# A11y Ally [<img alt="Get it on Google Play" src="https://play.google.com/intl/en_gb/badges/images/generic/en_badge_web_generic.png" height="50px" align="top" />](https://play.google.com/store/apps/details?id=com.quittle.a11yally) [![Build Status](https://travis-ci.com/quittle/a11y-ally.svg?branch=master)](https://travis-ci.com/quittle/a11y-ally)

<img align="left" src="src/main/custom-res/icon.svg" alt="A11y Ally Logo" height="80px" />
This tool is aimed at developers, designers, and testers to analyze and inspect Android applications'
A11y Ally (as in [Accessibility Ally](https://a11yproject.com/about/#what-does-the-term-a11y-mean))
tool is aimed at developers, designers, and testers to analyze and inspect Android applications'
accessibility to all users. Providing an AR-style overlay, it runs alongside your app and highlights
issues it discovers and provides insight into what assistive technology users experience when using
your app. In addition to providing exploratory feedback for a user manually interacting with their app,
A11y Ally can generate reports of accessibility issues it finds, making it possible to integrate into
automated testing.

**[Learn how to get started now!](GETTING_STARTED.md)**
<br />
<br />

Expand Down

0 comments on commit 9173777

Please sign in to comment.