From 91737772c1500a52bcc77ba2de4419f36995dee6 Mon Sep 17 00:00:00 2001 From: Dustin Toff Date: Tue, 28 May 2019 23:18:54 +0100 Subject: [PATCH] Added more getting started instructions to the documentation --- GETTING_STARTED.md | 9 +++++++++ README.md | 4 +++- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 GETTING_STARTED.md diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md new file mode 100644 index 00000000..ccfa329f --- /dev/null +++ b/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. diff --git a/README.md b/README.md index 69449143..ac998447 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # A11y Ally [Get it on Google Play](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) A11y Ally Logo -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)**