Skip to content

Commit 5ba75ef

Browse files
authored
Finish MapLibre onboarding (maplibre#51)
1 parent 2b856f5 commit 5ba75ef

File tree

3 files changed

+46
-3
lines changed

3 files changed

+46
-3
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ What issue is this PR targeting?
88
- [ ] If there are any visual changes as a result, include before/after screenshots and/or videos
99
- [ ] Add #fixes with the issue number that this PR addresses
1010
- [ ] Update any documentation for affected APIs
11+
- [ ] Update the CHANGELOG

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## Version 0.1.0 - 2024-09-21
9+
10+
This project has migrated from Stadia Maps to the MapLibre organization!
11+
To celebrate, we're bumping the version and adding a CHANGELOG.
12+
13+
Xcode and GitHub normally handle these sorts of changes well,
14+
but sometimes they don't.
15+
So, you'll probably want to be proactive and change your URLs from
16+
`https://github.com/stadiamaps/maplibre-swiftui-dsl-playground`
17+
to `https://github.com/maplibre/swiftui-dsl`.
18+
19+
If you're building a plain Xcode project, it might actually be easier to remove the Swift Package
20+
and all of its targets and then re-add with the URL.
21+
22+
Swift Package authors can simply update the URLs.
23+
Note that the package name also changes with the repo name.
24+
25+
```swift
26+
.product(name: "MapLibreSwiftDSL", package: "swiftui-dsl"),
27+
.product(name: "MapLibreSwiftUI", package: "swiftui-dsl"),
28+
```

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
Swift DSLs for [MapLibre Native](https://github.com/maplibre/maplibre-native), a free open-source renderer
88
for interactive vector maps, to enable better integration with SwiftUI and generally enable easier use of MapLibre.
99

10+
**NOTE: This package has migrated from Stadia Maps to the MapLibre organization 🎉**
11+
If you previously installed this package,
12+
see the [`CHANGELOG`](CHANGELOG.md) for steps to ensure Xcode stays happy.
13+
1014
![A screen recording demonstrating the declarative SwiftUI DSL reacting to changes live](demo.gif)
1115

1216
This package is a reimagining of the MapLibre API with a modern DSLs for SwiftUI.
@@ -32,19 +36,29 @@ Any breaking API changes will be reflected in release notes.
3236

3337
## Quick start
3438

39+
### In a normal Xcode project
40+
41+
If you're building an app using an Xcode project,
42+
the easiest way to add package dependencies is in the File menu.
43+
Search for the package using the repository URL: `https://github.com/maplibre/swiftui-dsl`.
44+
45+
### In a Swift package
46+
3547
Add the following to the main dependencies section of your `Package.swift`.
3648

3749
```swift
38-
.package(url: "https://github.com/stadiamaps/maplibre-swiftui-dsl-playground", branch: "main"),
50+
.package(url: "https://github.com/maplibre/swiftui-dsl", branch: "main"),
3951
```
4052

4153
Then, for each target add either the DSL (for just the DSL) or both (for the SwiftUI view):
4254

4355
```swift
44-
.product(name: "MapLibreSwiftDSL", package: "maplibre-swiftui-dsl-playground"),
45-
.product(name: "MapLibreSwiftUI", package: "maplibre-swiftui-dsl-playground"),
56+
.product(name: "MapLibreSwiftDSL", package: "swiftui-dsl"),
57+
.product(name: "MapLibreSwiftUI", package: "swiftui-dsl"),
4658
```
4759

60+
### Simple example: polyline rendering
61+
4862
Then, you can use it in a SwiftUI view body like this:
4963

5064
```swift

0 commit comments

Comments
 (0)