README.md in dryrun-0.9.0 vs README.md in dryrun-1.0.0
- old
+ new
@@ -1,33 +1,42 @@
-![Image](extras/logo.png)
+<p align="center">
+ <a href="https://github.com/cesarferreira/dryrun" target="_blank">
+ <img width="200"src="extras/gift.gif">
+ </a>
+</p>
+<h1 align="center">dryrun</h1>
+<p align="center"><strong>Try any android library</strong> hosted online <strong>directly</strong> from the <strong>command line</strong></p>
+<p align="center">
+ <a href="https://github.com/cesarferreira/dryrun"><img src="http://ruby-gem-downloads-badge.herokuapp.com/dryrun?type=total" alt="downloads"></a>
+ <a href="https://github.com/cesarferreira/dryrun"><img src="https://badge.fury.io/rb/dryrun.svg" alt="npm"></a>
+ <a href="https://travis-ci.org/cesarferreira/dryrun"><img src="https://travis-ci.org/cesarferreira/dryrun.svg?branch=master" alt="Build Status"></a>
+ <!-- <a href="http://android-arsenal.com/details/1/2361"><img src="https://img.shields.io/badge/Android%20Arsenal-dryrun-brightgreen.svg?style=flat" alt="Android Arsenal"></a> -->
+ <a href="http://androidweekly.net/issues/issue-200"><img src="https://img.shields.io/badge/Android%20Weekly-%23200-blue.svg" alt="Android Weekly"></a>
+ <a href="https://www.codacy.com/app/cesarferreira/dryrun?utm_source=github.com&utm_medium=referral&utm_content=cesarferreira/dryrun&utm_campaign=badger"><img src="https://api.codacy.com/project/badge/Grade/c9f73e75e72547008558b3e337acbff3" alt="Codacy Badge"></a>
+
+ <!-- <a href="https://github.com/cesarferreira/dryrun/issues"><img src="https://img.shields.io/github/issues-raw/cesarferreira/dryrun.svg" alt="issues"></a>
+ <a href="https://github.com/cesarferreira/dryrun/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a> -->
+</p>
-[![Build Status](https://travis-ci.org/cesarferreira/dryrun.svg?branch=master)](https://travis-ci.org/cesarferreira/dryrun)
-[![Gem Version](https://badge.fury.io/rb/dryrun.svg)](http://badge.fury.io/rb/dryrun)
-[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-dryrun-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/2361)
-[![Android Weekly](https://img.shields.io/badge/Android%20Weekly-%23200-blue.svg)](http://androidweekly.net/issues/issue-200)
+<p align="center">
+ <img src="extras/ss.gif" width="100%" />
+</p>
+## Install
-**Try** any **android library** hosted online **directly** from the **command line**
+```sh
+gem install dryrun
+```
-
-### Show some :heart:
-[![GitHub stars](https://img.shields.io/github/stars/cesarferreira/dryrun.svg?style=social&label=Star)](https://github.com/cesarferreira/dryrun)
-[![GitHub forks](https://img.shields.io/github/forks/cesarferreira/dryrun.svg?style=social&label=Fork)](https://github.com/cesarferreira/dryrun/fork) [![GitHub watchers](https://img.shields.io/github/watchers/cesarferreira/dryrun.svg?style=social&label=Watch)](https://github.com/cesarferreira/dryrun) [![GitHub followers](https://img.shields.io/github/followers/cesarferreira.svg?style=social&label=Follow)](https://github.com/cesarferreira/dryrun)
-[![Twitter Follow](https://img.shields.io/twitter/follow/cesarmcferreira.svg?style=social)](https://twitter.com/cesarmcferreira)
-
-
## Usage
+
```bash
dryrun https://github.com/cesarferreira/android-helloworld
```
-<p align="center">
-<img src="extras/usage_v4.gif" width="100%" />
-</p>
Wait a few seconds and the app is now opened on your phone :smiley:
-### Advanced usage
```bash
$ dryrun -h
Usage: dryrun GIT_URL [OPTIONS]
Options
@@ -40,56 +49,44 @@
-w, --wipe Wipe the temporary dryrun folder
-h, --help Displays help
-v, --version Displays the version
```
-## Installation
+## Alternative scenario (if you don't use `dryrun`)
- $ gem install dryrun
+1. Find the github's repository url
+2. Click the `download zip`
+3. Extract the `zip file`
+4. Open Android Studio
+5. Import the project you just downloaded
+6. Sync gradle
+7. Run the project
+8. Choose the device you want to run
+9. Test all you want
+10. Delete the `project folder` and the `zip file` when you don't want it anymore
## Goodies
- Private repos can be tested too :smiley:
```
$ dryrun git@github.com:cesarferreira/android-helloworld.git
```
-
- No need to cleanup after you test the library.
-
- No need to wait for **Android Studio** to load.
## Notes
-Behaware that ANDROID_HOME needs to be set with the adb path:
+Be aware that ANDROID_HOME needs to be set with the adb path:
- MAC -> ```ANDROID_HOME=/usr/local/opt/android-sdk```
- Linux -> ```ANDROID_HOME=/usr/local/opt/android-sdk```
- Windows -> ```ANDROID_HOME="...sdk"```
In windows this ANDROID_HOME is not automatically created, see more in [here](https://facebook.github.io/react-native/releases/0.21/docs/android-setup.html#define-the-android-home-environment-variable)
Additionally, on windows in order to use git commands, the following path should be on the environment variable
- ```...\Git\cmd ```
-## Alternative scenario (if you don't use `dryrun`)
+## Created by
+[Cesar Ferreira](https://cesarferreira.com)
-1. Find the github's repository url
-2. Click the `download zip`
-3. Extract the `zip file`
-4. Open Android Studio
-5. Import the project you just downloaded
-6. Sync gradle
-7. Run the project
-8. Choose the device you want to run
-9. Test all you want
-10. Delete the `project folder` and the `zip file` when you don't want it anymore
-
-## Contributing
-I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:
- 1. Match coding style (braces, spacing, etc.) This is best achieved using `CMD`+`Option`+`L` (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
- 2. If its a feature, bugfix, or anything please only change code to what you specify.
- 3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
- 4. Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get rejected.
- 5. Check for existing [issues](https://github.com/cesarferreira/dryrun/issues) first, before filing an issue.
- 6. Have fun!
-
-### Created & Maintained By
-[Cesar Ferreira](https://github.com/cesarferreira) ([@cesarmcferreira](https://www.twitter.com/cesarmcferreira))
+## License
+MIT © [Cesar Ferreira](http://cesarferreira.com)