Merge pull request #171 from launchdarkly/next-release

Version 3.0.1

.circleci/config.yml

@@ -2,7 +2,7 @@
 version: 2
 jobs:
   build:
-    working_directory: /Users/distiller/launchdarkly/ios-client/tmp
+    working_directory: /Users/distiller/launchdarkly/ios-client-sdk/tmp
     parallelism: 1    # controls the # of containers for the job. In theory, adding another container should halve the number of tests run in each container, but instead appears to run all tests in both containers.
     shell: /bin/bash --login
 
@@ -51,7 +51,7 @@ jobs:
 
     - run:
         name: Clean, Build, & Test Darkly_iOS
-        command: set -o pipefail && xcodebuild clean build test -workspace 'Darkly.xcworkspace' -scheme 'Darkly_iOS' -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone XS,OS=latest' CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY= PROVISIONING_PROFILE= | tee 'Darkly_iOS_xcode_raw.log' | xcpretty --color --report html --output '/Users/distiller/launchdarkly/ios-client/tmp/output/report.html' --report junit --output '/Users/distiller/launchdarkly/ios-client/tmp/output/xcode/report.junit'
+        command: set -o pipefail && xcodebuild clean build test -workspace 'Darkly.xcworkspace' -scheme 'Darkly_iOS' -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone XS,OS=latest' CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY= PROVISIONING_PROFILE= | tee 'Darkly_iOS_xcode_raw.log' | xcpretty --color --report html --output '/Users/distiller/launchdarkly/ios-client-sdk/tmp/output/report.html' --report junit --output '/Users/distiller/launchdarkly/ios-client-sdk/tmp/output/xcode/report.junit'
 
     - run:
         name: Clean & Build Darkly_watchOS

.circleci/run-build-locally.sh

@@ -1,6 +1,6 @@
 # A script that triggers a circleci build from the command line
 # Script from https://circleci.com/docs/2.0/examples/#video-test-your-config-file-locally
-# Usage: From the project folder (e.g. 'ios-client') run 'bash .circleci/run-build-locally.sh'
+# Usage: From the project folder (e.g. 'ios-client-sdk') run 'bash .circleci/run-build-locally.sh'
 #   Set the url to run in this format
 #   https://circleci.com/api/v1.1/project/<source, eg. github>/<user name>/<project name>/tree/<branch name>
 # Dependencies:
@@ -10,4 +10,4 @@ curl --user ${CIRCLE_TOKEN}: \
      --request POST \
      --form [email protected]/config.yml \
      --form notify=false \
-        https://circleci.com/api/v1.1/project/github/launchdarkly/ios-client/tree/master
+        https://circleci.com/api/v1.1/project/github/launchdarkly/ios-client-sdk/tree/master

.gitignore

@@ -24,4 +24,4 @@ DerivedData
 
 # Vim files
 *.swp
-/Carthage
+Carthage/Checkouts

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the LaunchDarkly iOS SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [3.0.1] - 2019-04-30
+### Changed
+- Deployed Carthage built DarklyEventSource frameworks as part of the Darkly project.
+
 ## [3.0.0] - 2019-04-17
 ### Changed
 - Renamed the non-iOS Darkly frameworks to include the platform name. e.g. Darkly_watchOS. Because non-CocoaPods apps will need to update imports for the new modules, advanced to the next major version.

CONTRIBUTING.md

@@ -1,5 +1,31 @@
-Contributing to LaunchDarkly SDK for iOS
-=========================================
+Contributing to the LaunchDarkly SDK for iOS
+================================================
 
-We encourage pull-requests and other contributions from the community. We've also published an [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work.
+LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.
 
+Submitting bug reports and feature requests
+------------------
+
+The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/ios-client-sdk/issues) in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.
+
+Submitting pull requests
+------------------
+
+We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
+
+Build instructions
+------------------
+
+### Prerequisites
+
+This SDK is built with [XCode](https://developer.apple.com/xcode/). This version is compatible with XCode 10.2.
+
+### Building
+
+The exact command used to build the SDK depends on where you want to use it (for example -- iOS, watchOS, etc.). Refer to the `xcodebuild` commands in the SDK's [continuous integration build configuration](.circleci/config.yml) for examples on how to build for the different platforms.
+
+If you wish to clean your working directory between builds, include the `clean` goal in your `xcodebuild` command(s).
+
+### Testing
+
+To build the SDK and run all unit tests, include the `test` goal in your `xcodebuild` command(s).