Update README for initial release

Author: jdee

README.md

@@ -1,96 +1,28 @@
 # branch plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg?style=flat-square)](https://rubygems.org/gems/fastlane-plugin-branch)
+[![Gem](https://img.shields.io/gem/v/fastlane-plugin-branch.svg?style=flat)](https://rubygems.org/gems/fastlane-plugin-branch)
+[![Downloads](https://img.shields.io/gem/dt/fastlane-plugin-branch.svg?style=flat)](https://rubygems.org/gems/fastlane-plugin-branch)
 [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/jdee/settings-bundle/blob/master/LICENSE)
 [![CircleCI](https://img.shields.io/circleci/project/github/BranchMetrics/fastlane-plugin-branch.svg)](https://circleci.com/gh/BranchMetrics/fastlane-plugin-branch)
 
-## Getting Started
-
-This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-branch`
-before it is released:
-
-### Install Fastlane
-
-https://docs.fastlane.tools/getting-started/android/setup/  
-https://docs.fastlane.tools/getting-started/ios/setup/
-
-Before release, the packaged `fastlane` binary available in the zip and via Homebrew will not
-work.
-
-```bash
-gem install fastlane -NV
-```
+## Preliminary release
 
-**Note:** If using the system Ruby, you must use `sudo`. However, using the system Ruby is not recommended. See
-[Notes on Ruby Version Managers](#notes-on-ruby-version-managers)
+This is a preliminary release of this plugin. Please report any problems by opening issues in this repo.
 
-### Set up Fastlane for your project
-
-**Option 1:** This may be easiest, but it requires more setup than is needed to try out this plugin.
-
-```bash
-fastlane init
-```
-
-**Option 2:** This is also easy and requires no further setup:
-
-```bash
-git checkout git@github.com:BranchMetrics/fastlane-plugin-branch
-cp -r fastlane-plugin-branch/fastlane /path/to/MyProject
-cp fastlane-plugin-branch/Branchfile /path/to/MyProject
-```
-
-Then modify the parameters in `/path/to/MyProject/Branchfile`.
-
-### Install this plugin
+## Getting Started
 
-Once released, you can install this plugin using
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-branch`, add it to your project by running:
 
 ```bash
 fastlane add_plugin branch
 ```
 
-That tries to install from Rubygems and will fail before release.
-
-To install before release:
-
-1. Add a `Gemfile` to your project with these contents (already there if you used fastlane init):
-
-  ```ruby
-  source 'https://rubygems.org'
-
-  gem "fastlane"
-
-  plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
-  eval_gemfile(plugins_path) if File.exist?(plugins_path)
-  ```
-
-2. Modify `/path/to/MyProject/fastlane/Pluginfile` to have these contents:
-
-  ```ruby
-  gem "fastlane-plugin-branch", git: "git@github.com/BranchMetrics/fastlane-plugin-branch"
-  ```
-
-  or
-
-  ```ruby
-  gem "fastlane-plugin-branch", path: "/where/I/checked/out/fastlane-plugin-branch"
-  ```
-
-3. Install the plugin
-
-  ```ruby
-  bundle install
-  ```
-
-**Note:** Before release, `fastlane` must always be run using `bundle exec fastlane <args>` in order
-to use this plugin.
-
 ## setup_branch action
 
 ### Prerequisites
 
-Before using this action, you should set your app up in the [Branch Dashboard](https://dashboard.branch.io). See https://dev.branch.io/basic-setup/ for details. To use the `setup_branch` action, you need:
+Before using this action, make sure to set up your app in the [Branch Dashboard](https://dashboard.branch.io). See https://dev.branch.io/basic-setup/ for details. To use the `setup_branch` action, you need:
 
 - Branch key(s), either live, test or both
 - Domain name(s) used for Branch links
@@ -103,19 +35,23 @@ This action automatically configures Xcode and Android projects that use the Bra
 for Universal Links, App Links and custom URI handling. It modifies Xcode project settings and entitlements as well as Info.plist and AndroidManifest.xml files.
 
 ```ruby
-setup_branch live_key: "key_live_xxxx",
-             test_key: "key_test_yyyy",
-   app_link_subdomain: "myapp",
-           uri_scheme: "myscheme", # Android only
- android_project_path: "MyAndroidApp", # MyAndroidApp/src/main/AndroidManifest.xml
-            xcodeproj: "MyIOSApp.xcodeproj"
+setup_branch(
+  live_key: "key_live_xxxx",
+  test_key: "key_test_yyyy",
+  app_link_subdomain: "myapp",
+  uri_scheme: "myscheme", # Android only
+  android_project_path: "MyAndroidApp", # MyAndroidApp/src/main/AndroidManifest.xml
+  xcodeproj: "MyIOSApp.xcodeproj"
+)
 ```
 
 Use the `:domains` parameter to specify custom domains, including non-Branch domains
 ```ruby
-setup_branch live_key: "key_live_xxxx",
-              domains: %w{example.com www.example.com}
-            xcodeproj: "MyIOSApp.xcodeproj"
+setup_branch(
+  live_key: "key_live_xxxx",
+  domains: %w{example.com www.example.com}
+  xcodeproj: "MyIOSApp.xcodeproj"
+)
 ```
 
 Available options:
@@ -157,15 +93,15 @@ validate_universal_links
 ```
 
 ```ruby
-validate_universal_links xcodeproj: "MyProject.xcodeproj"
+validate_universal_links(xcodeproj: "MyProject.xcodeproj")
 ```
 
 ```ruby
-validate_universal_links xcodeproj: "MyProject.xcodeproj", target: "MyProject"
+validate_universal_links(xcodeproj: "MyProject.xcodeproj", target: "MyProject")
 ```
 
 ```ruby
-validate_universal_links domains: %w{example.com www.example.com}
+validate_universal_links(domains: %w{example.com www.example.com})
 ```
 
 Available options:
@@ -185,6 +121,8 @@ one Universal Link domain configured for the target, and all Universal Link doma
 AASA validation. If the the :domains parameter is provided, the Universal Link domains in
 the project must also match the value of this parameter without regard to order.
 
+This action does not use the Branchfile.
+
 ## Example
 
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. To try it:
@@ -225,52 +163,3 @@ For more information about how the `fastlane` plugin system works, check out the
 ## About _fastlane_
 
 _fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
-
-## Notes on Ruby Version Managers
-
-The Ruby environment is notoriously troublesome. It is strongly recommended for
-all Ruby work to use a version manager, either [RVM](https://rvm.io) or
-[rbenv](https://github.com/rbenv/rbenv). A number of Fastlane actions have known
-issues using the system Ruby because of SSL cert problems. This action mainly
-modifies project files, so it is unlikely to have too much trouble with the
-system Ruby. However, similar issues could arise with Universal Link validation.
-
-Starting with 1.7.0, nokogiri requires Ruby 2.1. Apple ships 2.0, which is no
-longer a supported Ruby version as of February 2016. This is a strong argument
-in favor of using RVM or rbenv to get a current ruby (e.g. 2.4.1).
-
-If you're using the system Ruby, you'll need to add this line to the Gemfile in
-your app project:
-
-```Ruby
-gem 'nokogiri', '1.6.8.1'
-```
-
-You may also have to install this manually first using:
-
-```bash
-sudo gem install nokogiri -v 1.6.8.1
-```
-
-### Streamlined RVM installation
-
-```bash
-\curl -sSL https://get.rvm.io | bash --ruby
-```
-
-Note the initial backslash, recommended to avoid shell aliases, but not entirely necessary.
-
-Note that if GPG is detected, RVM will require a cert be installed in order to verify. On OS X:
-
-```bash
-gpg2 --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
-```
-
-```bash
-gem install bundler
-```
-
-**Note:** When using RVM, all gems and binaries are installed under `~/.rvm`. Do not use `sudo`
-to install or update gems or rubies.
-
-Now the `bundle` command is available in your `PATH` under `~/.rvm`.