README.md in dryrun-0.5.1 vs README.md in dryrun-0.5.2
- old
+ new
@@ -1,56 +1,47 @@
-# dryrun
-[](https://travis-ci.org/cesarferreira/dryrun) [](http://badge.fury.io/rb/dryrun) [](https://android-arsenal.com/details/1/2361)
+# dryrun
+[](https://travis-ci.org/cesarferreira/dryrun) [](http://badge.fury.io/rb/dryrun)
-**Try** any **android library** on your **smartphone** **directly** from the **command line**
+**Try** any **android library** hosted online **directly** from the **command line**
> A dry run is a testing process where the effects of a possible failure are intentionally mitigated. For example, an aerospace company may conduct a "dry run" test of a jet's new pilot ejection seat while the jet is parked on the ground, rather than while it is in flight.
<p align="center">
-<img src="https://raw.githubusercontent.com/cesarferreira/dryrun/master/extras/usage.gif" width="100%" />
+<img src="https://raw.githubusercontent.com/cesarferreira/dryrun/master/extras/usage_v2.gif" width="100%" />
</p>
-
## Usage
-```shell
+```bash
dryrun https://github.com/cesarferreira/android-helloworld
```
-Wait a few seconds... and `voilà`! The app is opened on your phone :smiley:
+Wait a few seconds and the app is now opened on your phone :smiley:
+### Advanced usage
+```bash
+$ dryrun -h
+Usage: dryrun GITHUB_URL [OPTIONS]
-## Advanced usage
-
-- From a custom repository folder:
-
-```shell
-dryrun repository_url -p custom/path/to/gradle_application
+Options
+ -m, --module MODULE_NAME Custom module to run
+ -p, --path PATH Custom path to android project
+ -h, --help Displays help
+ -v, --version Displays version
```
-- A custom module:
+## Installation
-```shell
-dryrun repository_url -m custom_application_module
-```
+ $ gem install dryrun
-- Help at any time:
-
-```shell
-dryrun -h
-```
-
-
## Goodies
- Private repos can be tested too :smiley:
+```
+ $ dryrun git@github.com:cesarferreira/android-helloworld.git
+```
- - assuming that you have the corresponding `private ssh keys` in your `~./ssh/`
-
- - > $ dryrun git@github.com:cesarferreira/android-helloworld.git
-
- No need to cleanup after you test the library.
- - Your operating system will clean the /tmp/ folder for you.
- No need to wait for **Android Studio** to load.
## Alternative scenario (if you don't use `dryrun`)
@@ -63,28 +54,8 @@
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
-## Installation
-
- $ gem install dryrun
-
-
-**Requirements `(if you haven't already)`:**
-
-> $ANDROID_HOME defined on the environment variables [(how-to)](http://stackoverflow.com/questions/5526470/trying-to-add-adb-to-path-variable-osx)
-
-
-> Android SDK in your $PATH [(how-to)](http://stackoverflow.com/questions/19986214/setting-android-home-enviromental-variable-on-mac-os-x)
-
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/cesarferreira/dryrun.
-
-To install gem as local you can use this:
-```shell
-# In the project folder:
-rake install
-# Next in the any gemset or place:
-gem install --local path_to_dryrun/pkg/dryrun-<builded_version>.gem
-```