diff --git a/README.md b/README.md index ffdfa328268e85a83cef7340c881a11e54eb72c4..a2278a0b4e4d386277245e922dd52a576f14d6ee 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ -# ios-template +# Introduction -Working location for iOS template project \ No newline at end of file +This is a template for getting started with iOS development using GitLab and [fastlane](https://fastlane.tools/). + +# Reference links + +- [GitLab CI Documentation](https://docs.gitlab.com/ee/ci/) +- [Blog post: Android publishing with iOS and fastlane](https://about.gitlab.com/2019/03/06/ios-publishing-with-gitlab-and-fastlane/) + +# Getting started + +You'll need a working MacOS development environment with XCode 10 to use this +template. You can find instructions to get up and running on the Apple [XCode website](https://developer.apple.com/xcode/). + +If you want to use GitLab CI with your own MacOS runners (a requirement since we +do not currently offer shared MacOS runners), please read through the blog +post above which will walk you through a working production configuration using +this approach. + +## What's contained in this project + +TBD