Improvements to examples and docs

Author: jdee

README.md

@@ -166,17 +166,60 @@ the project must also match the value of this parameter without regard to order.
 
 This action does not use the Branchfile.
 
-## Example
+## Examples
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. To try it:
+There is an example [Fastfile](./fastlane/Fastfile) in this repo that defines a number of
+example lanes. Be sure to run `bundle install` before trying any of the examples.
+
+### setup
+
+This lane sets up the BranchPluginExample projects
+in [examples/android/BranchPluginExample](./examples/android/BranchPluginExample) and
+[examples/ios/BranchPluginExample](./examples/ios/BranchPluginExample).
+The Xcode project uses CocoaPods and Swift.
+
+```bash
+bundle exec fastlane setup
+```
+
+### setup_and_commit
+
+This lane sets up the BranchPluginExample projects and also commits the results to git.
+
+```bash
+bundle exec fastlane setup
+```
+
+### setup_objc
+
+This lane sets up the BranchPluginExampleObjc project
+in [examples/ios/BranchPluginExampleObjc](./examples/ios/BranchPluginExampleObjc).
+The project uses CocoaPods and Objective-C.
 
 ```bash
-bundle exec fastlane validate         # The example project needs to be set up. This will fail.
-bundle exec fastlane setup            # Also validates the UL configuration.
-bundle exec fastlane setup_and_commit # Also commit changes to Git. (git reset --hard HEAD^ to erase the last commit)
-bundle exec fastlane validate         # Now validation will pass.
+bundle exec fastlane setup_objc
 ```
 
+### setup_carthage
+
+This lane sets up the BranchPluginExampleCarthage project
+in [examples/ios/BranchPluginExampleCarthage](./examples/ios/BranchPluginExampleCarthage).
+The project uses Carthage and Swift.
+
+```bash
+bundle exec fastlane setup_carthage
+```
+
+### validate
+
+This lane validates the Universal Link configuration for the BranchPluginExample
+project in [examples/ios/BranchPluginExample](./examples/ios/BranchPluginExample).
+
+```bash
+bundle exec fastlane validate
+```
+
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

fastlane/Branchfile

@@ -3,6 +3,4 @@
 live_key "key_live_dczvWn3zrK8575YRe07IgjblAAmfx51S"
 test_key "key_test_fbqC9k2BqS68Y1XQi7YVjakhCxomD6Z9"
 app_link_subdomain "wujv"
-android_project_path "examples/android/BranchPluginExample"
-xcodeproj "examples/ios/BranchPluginExample/BranchPluginExample.xcodeproj"
 frameworks %w{AdSupport CoreSpotlight SafariServices}

fastlane/Fastfile

@@ -1,19 +1,22 @@
-desc "Add Branch keys and Universal Link domains to BranchPluginExample"
+desc "Set up BranchPluginExample"
 lane :setup do
-  setup_branch
+  setup_branch android_project_path: "examples/android/BranchPluginExample",
+               xcodeproj: "examples/ios/BranchPluginExample/BranchPluginExample.xcodeproj"
 end
 
-desc "Add Branch keys and Universal Link domains to BranchPluginExample and commit to Git"
+desc "Set up BranchPluginExample and commit to Git"
 lane :setup_and_commit do
-  setup_branch commit: true # Use a string here for a custom commit message
+  setup_branch android_project_path: "examples/android/BranchPluginExample",
+               xcodeproj: "examples/ios/BranchPluginExample/BranchPluginExample.xcodeproj",
+               commit: true # Use a string here for a custom commit message
 end
 
-desc "Set up the BranchPluginExampleObjc"
+desc "Set up BranchPluginExampleObjc"
 lane :setup_objc do
   setup_branch xcodeproj: "examples/ios/BranchPluginExampleObjc/BranchPluginExampleObjc.xcodeproj"
 end
 
-desc "Set up the BranchPluginExampleCarthage"
+desc "Set up BranchPluginExampleCarthage"
 lane :setup_carthage do
   setup_branch xcodeproj: "examples/ios/BranchPluginExampleCarthage/BranchPluginExampleCarthage.xcodeproj"
 end