README.md in fastlane-plugin-aws_s3-0.2.0 vs README.md in fastlane-plugin-aws_s3-0.2.1
- old
+ new
@@ -1,32 +1,38 @@
-# fastlane-plugin-s3 `fastlane` Plugin
+# aws_s3 `fastlane` Plugin
-[](https://rubygems.org/gems/fastlane-plugin-s3)
+[](https://rubygems.org/gems/fastlane-plugin-aws_s3)
## Getting Started
This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with fastlane-plugin-s3, add it to your project by running:
```bash
-fastlane add_plugin s3
+fastlane add_plugin aws_s3
```
-## About s3
+## About aws_s3
Upload a new build to Amazon S3 to distribute the build to beta testers. Works for both Ad Hoc and Enterprise signed applications. This step will generate the necessary HTML, plist, and version files for you.
-The `s3` action can upload both iOS apps (IPAs) and Android apps (APKs). It is **highly** suggested that you make a separate bucket for each of the apps.
+The `aws_s3` action can upload both iOS apps (IPAs) and Android apps (APKs). It is **highly** suggested that you make a separate bucket for each of the apps.
-Add the `s3` action after the `gym` step:
+Below is what the default generated page looks like that gets hosted on S3.
+
+
+## Example
+
+Add the `aws_s3` action after the `gym` step:
+
```ruby
-s3
+aws_s3
```
You can also customize a lot of options:
```ruby
-s3(
+aws_s3(
# All of these are used to make Shenzhen's `ipa distribute:s3` command
access_key: ENV['S3_ACCESS_KEY'], # Required from user.
secret_access_key: ENV['S3_SECRET_ACCESS_KEY'], # Required from user.
bucket: ENV['S3_BUCKET'], # Required from user.
region: ENV['S3_REGION'], # Required from user.
@@ -52,16 +58,10 @@
"latestVersion": "<%= full_version %>",
"updateUrl": "itms-services://?action=download-manifest&url=<%= url %>"
}
```
-## Example
-
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
-
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
-
## Issues and Feedback
For any other issues and feedback about this plugin, please submit it to this repository.
## Troubleshooting
@@ -73,5 +73,12 @@
For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md) in the main `fastlane` repo.
## About `fastlane`
`fastlane` automates building, testing, and releasing your app for beta and app store distributions. To learn more about `fastlane`, check out [fastlane.tools](https://fastlane.tools).
+
+## Author
+
+Josh Holtz, josh@rokkincat.com, [@joshdholtz](https://twitter.com/joshdholtz)
+
+I'm available for freelance work (Fastlane, iOS, and Android development) :muscle:
+Feel free to contact me :rocket: