Skip to content

Commit 3ef1430

Browse files
authored
Update README.md
1 parent 9f17b6d commit 3ef1430

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
11
# SDL MobileWeather Example App
22

3-
Set your [DarkSky API key](https://www.darksky.net/dev) into `Settings.h` to use.
3+
This example app uses the DarkSky API to present a basic connected weather app with SDL UI.
4+
5+
## Configuration
6+
7+
### DarkSky
8+
1. Sign up and get your own [DarkSky](https://www.darksky.net/dev) API key.
9+
1. Set the API key into `Settings.h` to use.
10+
11+
### SDL
12+
You will need to customize the configuration of the app depending on whether you are connecting it to a module over IAP (USB or Bluetooth) or TCP (Manticore or an emulator).
13+
14+
To check what type of connection is currently set up, go to `SmartDeviceLinkService.m` and go to the `-(void)start` method. There you will see a call to `SDLLifecycleConfiguration defaultConfigurationWithAppName` and one to `SDLLifecycleConfiguration debugConfigurationWithAppName` where one is active and the other is commented out. For more information on these calls, see [the network connection type guide](https://smartdevicelink.com/en/guides/iOS/getting-started/integration-basics/#network-connection-type). Depending on if you are connecting over IAP or TCP you may need to configure and alter these calls.
15+
16+
## Connecting
17+
Once you've configured the app with your own DarkSky API key and based on the device you are connecting to, you only have to run the app on your device (IAP or TCP) or a Simulator (TCP-only) and connect!

0 commit comments

Comments
 (0)