diff --git a/README.md b/README.md index d56fba4..3d301f4 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,49 @@ # Example Swift iOS application for CloudBees platform Feature management -Use this example application to integrate with the CloudBees platform and test feature management. After integrating, watch the application display change in response to any updates you make to flag values in the platform. +Use this example application to integrate with the CloudBees platform and test feature management. After integrating, observe the application display change in response to any updates you make to flag values in the platform. In the example swift application, the ROX SDK is already set up, and feature flags are already coded in. - -## Running This Project +## Get started with this project To get started with the swift-fm-example project, follow these steps: -1. **Get key from Cloudbees account:** - - - Create a CloudBees Feature management account. See [Signup Page](https://app.rollout.io/signup) to create an account. - - Get your environment key. Copy your environment key from App settings > Environments > Key. - -2. **Clone the Repository:** -Clone the swift-fm-example repository to your local machine using Git: +1. **Clone the Repository:** +Clone the swift-fm-example repository to your local machine using Git: ```shell git@github.com:cloudbees-io/swift-fm-example.git ``` -3. **Install ROX dependency via pod:** - - Install CocoaPods as described in [CocoaPods Getting Started](https://guides.cocoapods.org/using/getting-started.html#getting-started). - - In Terminal, `cd` to your project directory and type `pod install`. - +2. **Open the Project:** + + - Reopen your project in Xcode. -4. **Open the Project:** - - - Reopen your project in Xcode using the new `.xcworkspace` file. +3. **Get the SDK key:** + - Create a CloudBees feature management account. Refer to [Signup Page](https://cloudbees.io/signup) to create an account. + - Locate and copy your SDK key: + -- Navigate to **Feature management > Flags**. + -- Select an application. + -- Select the **copy** button next to the SDK key on the page. + - If you do not see an SDK key: + -- Navigate to **Feature management > Flags**. + -- Select **Installation instructions** in the upper right corner. + -- Follow the installation instructions. + -- Close the installation instructions, you may now copy the SDK Key. -5. **Setup key from Cloudbees account:** +4. **Add the SDK key:** - - In the ConfigurationManager.swift file, replace the `` with your corresponding API key: + - In the ConfigurationManager.swift file, replace the `` with your corresponding SDK key: ``` - ROX.setup(withKey: "", options: options) + ROX.setup(withKey: "", options: options) ``` -6. **Run the swift-fm-example App:** +5. **Run the swift-fm-example App:** - Use Xcode to run the swift-fm-example app by selecting Product > Run or pressing `Cmd + R`. This will launch the app. ## Use the platform to update flag values -Now that your application is running go to your environment in Feature management to display the flags available in the example application: +Now that your application is running, go to your environment in Feature management to display the flags available in the example application: Table 1. Feature flags in the example application. @@ -56,13 +57,17 @@ Table 1. Feature flags in the example application. **To update flags in the platform UI:** -1. Select **Feature management** from the left pane. -2. Select the vertical ellipsis icon next to the flag you want to configure. -3. Select **Configure**. -4. Select the **Environment** you used for copying the SDK key. -5. Update a flag value and save your changes. -6. Switch the **Configuration status** to **On**. +1. Select **Feature management** from the left pane. +2. Select the application. +3. Select the vertical ellipsis next to the flag you want to configure. +4. Select **Configure**. +5. Select the **Environment** for the SDK key. +6. Update a flag value and save your changes. +7. Set the **Configuration status** to **On**. + +## Documentation reference + +Refer to the CloudBees cloud-native platform documentation, link:https://docs.cloudbees.com/docs/cloudbees-platform/latest/install-sdk/[install the Feature management SDK] for more information. + -## Video Preview -[![Video Preview](assets/fm-ios-thumb.jpg)](assets/fm-screen-rec.mov)