Skip to content

Commit

Permalink
docs updated for end users
Browse files Browse the repository at this point in the history
  • Loading branch information
tishma committed Jul 6, 2015
1 parent 2cf51d7 commit 2d184ae
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,28 @@

[![Build Status](https://magnum.travis-ci.com/testfairy/testfairy-android-studio-plugin.svg?token=dEpogdhSnM976NXR45qA&branch=master)](https://magnum.travis-ci.com/testfairy/testfairy-android-studio-plugin)

## Requirements
TestFairy Integration intellij plugin has been tested on IDEA 13 and Android Studio 1.1+ (Android Studio will be used in further text for brevity).

It is based on [TestFairy plugin for Gradle](https://github.com/testfairy/testfairy-gradle-plugin),
so it requires a Gradle based Android application module.

At the moment, we only support Android Studio projects with settings.gradle in project root
and Android application module included on its very first line.

## Plugin Setup
1. Download plugin installation from: [TestFairy Integration plugin releases](https://github.com/testfairy/testfairy-android-studio-plugin/releases)
1. Go to Android Studio Preferences (Mac OS: Android Studio/Preferences; Others: File/Settings), and type Plugins.
1. Click on 'Install plugin from disk...'.
1. Locate the downloaded file and select it.

## Usage
To upload the android app to TestFairy, use Tools/TestFairy/Upload to TestFairy or click on TestFairy toolbar icon near the Build and Run buttons.

The first time you do it, the plugin will prompt you for your IDE Master Password (if you have one) and TestFairy API key.
After that, your project will be configured for integrated uploads to TestFairy.

In order to change TestFairy API key, you can always go to Tools/TestFairy/Settings.
The plugin will always apply the most recently entered API key to your projects.


0 comments on commit 2d184ae

Please sign in to comment.