Skip to content

Commit

Permalink
Merge pull request #123 from heremaps/ps/IOTSDK-1710_update_doc
Browse files Browse the repository at this point in the history
IOTSDK-1710: Update documentation
  • Loading branch information
PiotrSzmyt authored Apr 9, 2019
2 parents b18796f + ac2e399 commit 733dd39
Show file tree
Hide file tree
Showing 15 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion Commons/Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>2.1.0</string>
<string>2.1.1</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
Expand Down
4 changes: 2 additions & 2 deletions Documentation/Guides/QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you are new to iOS development please follow the guides on [developer.apple.c

>The example project is called "HelloMSDKUI" and it can be found [here](../Guides_Examples).
For this Quick Start app, we have used Xcode 10.1 and Swift 4.2. Start Xcode and select:
For this Quick Start app, we have used Xcode 10.2 and Swift 5.0. Start Xcode and select:
- _Create a new Xcode project_.
- As template, it is sufficient to choose _iOS_ => _Application_ => _Single View App_.
- Provide a project name, e.g. "HelloMSDKUI" and select _Swift_ as language.
Expand All @@ -62,7 +62,7 @@ To run CocoaPods, please close Xcode and create a new "Podfile" in your project'
```ruby
target 'HelloMSDKUI' do
platform :ios, '10.0'
pod 'HEREMapsUI', '2.1.0'
pod 'HEREMapsUI', '2.1.1'
end
```

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Guides/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The HERE Mobile SDK UI Kit builds upon optimized native platform code to fully s

With the HERE Mobile SDK UI Kit, realizing complete apps including comprehensive route planning and state-of-the-art guidance becomes a matter of minutes. While hiding the underlying complexity, you still have all the freedom you need to build unique and powerful apps - take a quick tour with our [HERE Mobile SDK UI Kit Primer](#getting-started---a-here-mobile-sdk-ui-kit-primer) to see a practical example.

Version 1.x of the HERE Mobile SDK UI Kit mainly focuses on enabling user experiences related to route planning and guidance. The HERE Mobile SDK UI Kit components are available for iOS and Android, supporting Java and Kotlin on Android, and Swift on iOS.
Version 2.x of the HERE Mobile SDK UI Kit mainly focuses on enabling user experiences related to route planning and guidance. The HERE Mobile SDK UI Kit components are available for iOS and Android, supporting Java and Kotlin on Android, and Swift on iOS.

## Where to start?
- If you haven't done so, please read our [Quick Start](QuickStart.md) guide to see how you can integrate the HERE Mobile SDK UI Kit into your own apps.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.here.msdkui.example;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_VERSION = 4.2;
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = "1,2";
};
name = Debug;
Expand All @@ -403,7 +403,7 @@
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.here.msdkui.example;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_VERSION = 4.2;
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = "1,2";
};
name = Release;
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Guides_Examples/HelloMSDKUI/Podfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
target 'HelloMSDKUI' do
platform :ios, '10.0'
pod 'HEREMapsUI', '2.1.0'
pod 'HEREMapsUI', '2.1.1'
end
12 changes: 6 additions & 6 deletions Documentation/Guides_Examples/HelloMSDKUI/Podfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PODS:
- HEREMaps (3.10.1)
- HEREMapsUI (2.1.0):
- HEREMaps (= 3.10.1)
- HEREMaps (3.11.0)
- HEREMapsUI (2.1.1):
- HEREMaps (= 3.11.0)

DEPENDENCIES:
- HEREMapsUI (= 2.1.0)
Expand All @@ -12,9 +12,9 @@ SPEC REPOS:
- HEREMapsUI

SPEC CHECKSUMS:
HEREMaps: 223c0a85c61b4336fb31c45160c249bb1625a0e3
HEREMapsUI: d82d5246fc5942ed49383129135a38c33df0daca
HEREMaps: 2242f865f55aa8f3d2d00b8b2ef47555f4d105d0
HEREMapsUI: 47ca81347f62188289144b1c559fac001a4b04e7

PODFILE CHECKSUM: e49df25d859c3b55231e92e60778c8b6f9359d95
PODFILE CHECKSUM: b80a63c79c335b08769bc150f05f86253084eff8

COCOAPODS: 1.6.1
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.here.msdkui.example;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_VERSION = 4.2;
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = "1,2";
};
name = Debug;
Expand All @@ -441,7 +441,7 @@
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.here.msdkui.example;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_VERSION = 4.2;
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = "1,2";
};
name = Release;
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Guides_Examples/MSDKUIPrimer/Podfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
target 'MSDKUIPrimer' do
platform :ios, '10.0'
pod 'HEREMapsUI', '2.1.0'
pod 'HEREMapsUI', '2.1.1'
end
12 changes: 6 additions & 6 deletions Documentation/Guides_Examples/MSDKUIPrimer/Podfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PODS:
- HEREMaps (3.10.1)
- HEREMapsUI (2.1.0):
- HEREMaps (= 3.10.1)
- HEREMaps (3.11.0)
- HEREMapsUI (2.1.1):
- HEREMaps (= 3.11.0)

DEPENDENCIES:
- HEREMapsUI (= 2.1.0)
Expand All @@ -12,9 +12,9 @@ SPEC REPOS:
- HEREMapsUI

SPEC CHECKSUMS:
HEREMaps: 223c0a85c61b4336fb31c45160c249bb1625a0e3
HEREMapsUI: d82d5246fc5942ed49383129135a38c33df0daca
HEREMaps: 2242f865f55aa8f3d2d00b8b2ef47555f4d105d0
HEREMapsUI: 47ca81347f62188289144b1c559fac001a4b04e7

PODFILE CHECKSUM: f07a650e9c5a3531d063ca01558fc2f2cc2d8677
PODFILE CHECKSUM: ef1e792e247ab4dcfebc3d0885856555ac350204

COCOAPODS: 1.6.1
4 changes: 2 additions & 2 deletions HEREMapsUI.podspec
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
Pod::Spec.new do |s|
s.name = 'HEREMapsUI'
s.module_name = 'MSDKUI'
s.version = '2.1.0'
s.version = '2.1.1'
s.summary = 'HEREMapsUI (MSDKUI) provides ready-to-use UI components for the HERE Mobile SDK for iOS.'
s.description = 'HEREMapsUI (MSDKUI) aims to make life easier for the iOS developers using the HERE Mobile SDK for iOS. It provides ready-to-use UI components with strong customization support. Plus, it supports accessibility and localization.'
s.homepage = 'https://github.com/heremaps/msdkui-ios'
s.license = { :type => 'Apache-2.0', :file => 'LICENSE' }
s.author = { 'HERE Europe B.V.' => '' }
s.source = { :git => 'https://github.com/heremaps/msdkui-ios.git', :tag => s.version.to_s }
s.ios.deployment_target = '10.0'
s.swift_version = '4.2'
s.swift_version = '5.0'
s.source_files = 'MSDKUI/Classes/**/*'
s.resource_bundles = {
'MSDKUI' => ['MSDKUI/Assets/*.png', 'MSDKUI/Assets/*.xib', 'MSDKUI/Assets/*.lproj']
Expand Down
6 changes: 3 additions & 3 deletions MSDKUI.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -2314,7 +2314,7 @@
PRODUCT_BUNDLE_IDENTIFIER = com.here.msdkui.devapp;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG;
SWIFT_VERSION = 4.2;
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = "1,2";
};
name = Debug;
Expand All @@ -2340,7 +2340,7 @@
MTL_FAST_MATH = YES;
PRODUCT_BUNDLE_IDENTIFIER = com.here.msdkui.devapp;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_VERSION = 4.2;
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = "1,2";
};
name = Release;
Expand All @@ -2366,7 +2366,7 @@
MTL_FAST_MATH = YES;
PRODUCT_BUNDLE_IDENTIFIER = com.here.msdkui.devapp;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_VERSION = 4.2;
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = "1,2";
};
name = Analyze;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ final class AboutTableViewDataSourceTests: XCTestCase {
// First item
let firstItem = try require(dataSource?.item(at: IndexPath(row: 0, section: 0)))
XCTAssertLocalized(firstItem.title, key: "msdkui_app_app_version", "It has the correct title")
XCTAssertEqual(firstItem.description, "2.1.0", "It has the correct description")
XCTAssertEqual(firstItem.description, "2.1.1", "It has the correct description")

// Second item
let secondItem = try require(dataSource?.item(at: IndexPath(row: 1, section: 0)))
XCTAssertLocalized(secondItem.title, key: "msdkui_app_ui_kit_version", "It has the correct title")
XCTAssertEqual(secondItem.description, "2.1.0", "It has the correct description")
XCTAssertEqual(secondItem.description, "2.1.1", "It has the correct description")

// Third item
let thirdItem = try require(dataSource?.item(at: IndexPath(row: 2, section: 0)))
Expand Down Expand Up @@ -101,6 +101,6 @@ final class AboutTableViewDataSourceTests: XCTestCase {
let cell = dataSource?.tableView(try require(tableView), cellForRowAt: IndexPath(row: 1, section: 0)) as? AboutTableViewCell

XCTAssertLocalized(cell?.textLabel?.text, key: "msdkui_app_ui_kit_version", "It has the correct text")
XCTAssertEqual(cell?.detailTextLabel?.text, "2.1.0", "It has the correct detail text")
XCTAssertEqual(cell?.detailTextLabel?.text, "2.1.1", "It has the correct detail text")
}
}
2 changes: 1 addition & 1 deletion MSDKUI_Tests/VersionTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ final class VersionTests: XCTestCase {

/// Tests that the framework version is correctly retrieved.
func testFrameworkVersion() {
let expectedVersion = "2.1.0"
let expectedVersion = "2.1.1"

XCTAssertEqual(Version.getString(), expectedVersion, "Not the expected version!")
}
Expand Down
4 changes: 2 additions & 2 deletions Podfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PODS:
- EarlGrey (1.15.0)
- HEREMaps (3.11.0)
- HEREMapsUI (2.1.0):
- HEREMapsUI (2.1.1):
- HEREMaps (= 3.11.0)
- OCMock (3.4.3)
- SwiftLint (0.31.0)
Expand All @@ -26,7 +26,7 @@ EXTERNAL SOURCES:
SPEC CHECKSUMS:
EarlGrey: 289a16cc7d08a54b962d72881b21e36d5103b549
HEREMaps: 2242f865f55aa8f3d2d00b8b2ef47555f4d105d0
HEREMapsUI: 63226b939791e75926dba0e34a0675bd4a764de2
HEREMapsUI: 47ca81347f62188289144b1c559fac001a4b04e7
OCMock: 43565190abc78977ad44a61c0d20d7f0784d35ab
SwiftLint: 7a0227733d786395817373b2d0ca799fd0093ff3

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ The HERE Mobile SDK UI Kit is already fully localized for the following language
- Vietnamese

## Supported platforms
The HERE Mobile SDK UI Kit components are available for iOS and [Android](https://github.com/heremaps/msdkui-android). The required HERE Mobile SDK is Version 3.10.0, only the _Premium edition_ is supported. The HERE Mobile SDK UI Kit supports scooter routing. Please, make sure to extend your license key if you want to include scooter routing in your app.
The HERE Mobile SDK UI Kit components are available for iOS and [Android](https://github.com/heremaps/msdkui-android). The required HERE Mobile SDK is Version 3.11.0, only the _Premium edition_ is supported. The HERE Mobile SDK UI Kit supports scooter routing. Please, make sure to extend your license key if you want to include scooter routing in your app.

### iOS Environment
- The HERE Mobile SDK UI Kit supports Xcode 10.2, Swift 5.0 and CocoaPods 1.6.1 (or higher).
- The HERE Mobile SDK UI Kit supports Xcode 10.2, Swift 5.0 and CocoaPods 1.6.1.
- Minimum deployment target is iOS 10.0.

## Quick Start
Expand Down

0 comments on commit 733dd39

Please sign in to comment.