diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f870b43..401483f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,3 +8,4 @@ What issue is this PR targeting? - [ ] If there are any visual changes as a result, include before/after screenshots and/or videos - [ ] Add #fixes with the issue number that this PR addresses - [ ] Update any documentation for affected APIs +- [ ] Update the CHANGELOG diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2729ab1 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,28 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Version 0.1.0 - 2024-09-21 + +This project has migrated from Stadia Maps to the MapLibre organization! +To celebrate, we're bumping the version and adding a CHANGELOG. + +Xcode and GitHub normally handle these sorts of changes well, +but sometimes they don't. +So, you'll probably want to be proactive and change your URLs from +`https://github.com/stadiamaps/maplibre-swiftui-dsl-playground` +to `https://github.com/maplibre/swiftui-dsl`. + +If you're building a plain Xcode project, it might actually be easier to remove the Swift Package +and all of its targets and then re-add with the URL. + +Swift Package authors can simply update the URLs. +Note that the package name also changes with the repo name. + +```swift + .product(name: "MapLibreSwiftDSL", package: "swiftui-dsl"), + .product(name: "MapLibreSwiftUI", package: "swiftui-dsl"), +``` diff --git a/README.md b/README.md index 5c1f4e3..684ed39 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,10 @@ Swift DSLs for [MapLibre Native](https://github.com/maplibre/maplibre-native), a free open-source renderer for interactive vector maps, to enable better integration with SwiftUI and generally enable easier use of MapLibre. +**NOTE: This package has migrated from Stadia Maps to the MapLibre organization 🎉** +If you previously installed this package, +see the [`CHANGELOG`](CHANGELOG.md) for steps to ensure Xcode stays happy. + ![A screen recording demonstrating the declarative SwiftUI DSL reacting to changes live](demo.gif) 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. ## Quick start +### In a normal Xcode project + +If you're building an app using an Xcode project, +the easiest way to add package dependencies is in the File menu. +Search for the package using the repository URL: `https://github.com/maplibre/swiftui-dsl`. + +### In a Swift package + Add the following to the main dependencies section of your `Package.swift`. ```swift - .package(url: "https://github.com/stadiamaps/maplibre-swiftui-dsl-playground", branch: "main"), + .package(url: "https://github.com/maplibre/swiftui-dsl", branch: "main"), ``` Then, for each target add either the DSL (for just the DSL) or both (for the SwiftUI view): ```swift - .product(name: "MapLibreSwiftDSL", package: "maplibre-swiftui-dsl-playground"), - .product(name: "MapLibreSwiftUI", package: "maplibre-swiftui-dsl-playground"), + .product(name: "MapLibreSwiftDSL", package: "swiftui-dsl"), + .product(name: "MapLibreSwiftUI", package: "swiftui-dsl"), ``` +### Simple example: polyline rendering + Then, you can use it in a SwiftUI view body like this: ```swift