Skip to content

Commit

Permalink
Merge pull request #652 from ably/fix-example-app-instructions
Browse files Browse the repository at this point in the history
Fix example app instructions
  • Loading branch information
lawrence-forooghian committed Jun 26, 2023
2 parents 8a3b1f9 + 1c4902b commit b39e518
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,9 @@ _You can find the version on the [releases](https://github.com/ably/ably-asset-t

- If you have not already, [configure your development machine](#mapbox-setup) so that it has permissions to download the Mapbox Navigation SDK.
- An `Examples/Secrets.xcconfig` file containing credentials (keys/ tokens) is required to build the example apps. (You can use the example `Examples/Example.Secrets.xcconfig`, e.g. by running `cp Examples/Example.Secrets.xcconfig Examples/Secrets.xcconfig`). Update the following values in `Examples/Secrets.xcconfig`:
- `ABLY_API_KEY`: Used by all example apps to authenticate with Ably using basic authentication. Not recommended in production, and can be taken from [here](https://ably.com/accounts).
- `MAPBOX_ACCESS_TOKEN`: Used to access Mapbox Navigation SDK/ APIs, and can be taken from [here](https://account.mapbox.com/). Using the Mapbox token is only required to run the **Publisher** example apps.
- Open `AblyAssetTracking.xcworkspace` to open an Xcode workspace containing the Subscriber example app and the Swift Package containing the SDKs that showcase how to use the subscriber part of the Ably Asset Tracking SDKs.
- Open `PublisherExample.xcodeproj` to open an Xcode workspace containing the Publisher exmple app
- `ABLY_API_KEY`: Used by all example apps to authenticate with Ably using basic authentication. Not recommended in production, and can be taken from [here](https://ably.com/accounts).
- `MAPBOX_ACCESS_TOKEN`: Used to access Mapbox Navigation SDK/ APIs, and can be taken from [here](https://account.mapbox.com/). Using the Mapbox token is only required to run the **Publisher** example apps.
- To run the example apps, open`AblyAssetTracking.xcworkspace` and then run the `PublisherExample` or `SubscriberExample` target.

### AWS S3 support in publisher app (optional)

Expand Down

0 comments on commit b39e518

Please sign in to comment.