Skip to content

Commit

Permalink
Merge pull request #2 from roblabs/master
Browse files Browse the repository at this point in the history
Update Docs
  • Loading branch information
petr-pokorny-1 committed Jan 27, 2021
2 parents 7eaf6a9 + c3b8256 commit f18027c
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import PackageDescription

let package = Package(
name: "maplibre-gl-native",
name: "MapLibre GL Native",
products: [
.library(
name: "Mapbox",
Expand Down
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
# MapBox GL Native SDK Open-Source Fork
# MapLibre GL Native SDK for iOS

For iOS and Android
![Requires Xcode 12](https://img.shields.io/badge/Xcode-12-1575F9.svg?style=flat&logo=xcode&logoColor=1575F9)
[![Requires Swift 5.3](https://img.shields.io/badge/Swift-5.3-FA7343.svg?style=flat&logo=Swift)](https://swift.org/package-manager/)
![SPM compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-FA7343.svg?style=flat&logo=Swift)

MapLibre GL Native is a community led fork derived from [mapbox-gl-native](https://github.com/mapbox/mapbox-gl-native) prior to their switch to a non-OSS license. The fork also includes Maps SDK for iOS and MacOS (forked from [mapbox-gl-native-ios](https://github.com/mapbox/mapbox-gl-native-ios)) and Android SDK (forked from [mapbox-gl-native-android](https://github.com/mapbox/mapbox-gl-native-android)).
[MapLibre GL Native](https://github.com/maptiler/maplibre-gl-native) is a community led fork derived from [mapbox-gl-native](https://github.com/mapbox/mapbox-gl-native) prior to their switch to a non-OSS license. The fork also includes Maps SDK for iOS and macOS (forked from [mapbox-gl-native-ios](https://github.com/mapbox/mapbox-gl-native-ios)) and Android SDK (forked from [mapbox-gl-native-android](https://github.com/mapbox/mapbox-gl-native-android)).

---

## Add MapLibre to your Project

To add a package dependency to your Xcode project, select File > Swift Packages > Add Package Dependency and enter its repository URL. See [Adding Package Dependencies to Your App.](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app)

## Swift Packages Development

You can override the MapLibre package dependency and edit its content by adding it as a local package. See [Editing a Package Dependency as a Local Package](https://developer.apple.com/documentation/swift_packages/editing_a_package_dependency_as_a_local_package).

You can add this to `Package.swift`

```swift
.binaryTarget(
name: "Mapbox",
path: "build/output/Mapbox.xcframework"),
```

Other References from developer.apple.com

* Find out if a package dependency references a binary and verify the binary’s authenticity. See [Identifying Binary Dependencies.](https://developer.apple.com/documentation/swift_packages/identifying_binary_dependencies)

1 comment on commit f18027c

@petr-pokorny-1
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also updated the swift package template in maplibre-gl-native maplibre/maplibre-native@986c9b5

Please sign in to comment.