diff --git a/README.md b/README.md index dc9851f..48466c9 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,31 @@ fastlane add_plugin mobile_center ## About mobile_center -Distribute new release to Mobile Center +Plugin for [https://mobile.azure.com](https://mobile.azure.com). Provides `mobile_center_upload` action for [release distribution](https://docs.microsoft.com/en-us/mobile-center/distribution/uploading) and [dSYM uploads](https://docs.microsoft.com/en-us/mobile-center/crashes/ios) +## Usage +Obtain an [API token](https://docs.microsoft.com/en-us/mobile-center/api-docs/). API Token is used for authentication for all Mobile Center API calls. + +``` +mobile_center_upload( + api_token: , + owner_name: , + app_name: , + apk: +) +``` ## 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) +Sample uses `.env` for setting private variables like API token, owner name, .etc. You need to replace it in `Fastfile` by your own values. + +There are three examples in `test` lane: +- upload release for android with minimum required parameters +- upload release for ios with all set parameters +- upload only dSYM file for ios ## Run tests for this plugin @@ -51,6 +67,16 @@ For more information about how the `fastlane` plugin system works, check out the _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). -# Contributing +## Contributing This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +## Contact + +### Intercom + +If you have further questions, want to provide feedback or you are running into issues, log in to the Mobile Center portal and use the blue Intercom button on the bottom right to start a conversation with us. + +### Twitter + +We're on Twitter as @mobilecenter. diff --git a/fastlane-plugin-mobile_center.gemspec b/fastlane-plugin-mobile_center.gemspec index 156f4e6..761829a 100644 --- a/fastlane-plugin-mobile_center.gemspec +++ b/fastlane-plugin-mobile_center.gemspec @@ -7,10 +7,9 @@ require 'fastlane/plugin/mobile_center/version' Gem::Specification.new do |spec| spec.name = 'fastlane-plugin-mobile_center' spec.version = Fastlane::MobileCenter::VERSION - spec.author = 'Microsoft' - spec.email = '' + spec.author = 'Microsoft Corporation' - spec.summary = 'Distribute new release to Mobile Center' + spec.summary = 'Fastlane plugin for Mobile Center' # spec.homepage = "https://github.com//fastlane-plugin-mobile_center" spec.license = "MIT"