summaryrefslogtreecommitdiff
path: root/platform/ios/scripts/release-notes-jazzy.md.ejs
diff options
context:
space:
mode:
authorJason Wray <jason@mapbox.com>2018-08-21 19:16:18 -0400
committerJason Wray <jason@mapbox.com>2018-08-22 13:05:49 -0400
commit5e213d0db1bf1674e9a3374a9c0325b9a150c5d8 (patch)
treefe7215ad90d2c0c234029ab179d414fb33285eb0 /platform/ios/scripts/release-notes-jazzy.md.ejs
parentd31df6a615aee731199e992cf8e1d1f8e87daf66 (diff)
downloadqtlocation-mapboxgl-5e213d0db1bf1674e9a3374a9c0325b9a150c5d8.tar.gz
[ios, build] Improve jazzy readme generation
- Include changelogs for all releases in the current semver minor series. - Use template for jazzy readme.
Diffstat (limited to 'platform/ios/scripts/release-notes-jazzy.md.ejs')
-rw-r--r--platform/ios/scripts/release-notes-jazzy.md.ejs23
1 files changed, 23 insertions, 0 deletions
diff --git a/platform/ios/scripts/release-notes-jazzy.md.ejs b/platform/ios/scripts/release-notes-jazzy.md.ejs
new file mode 100644
index 0000000000..12b7480a2b
--- /dev/null
+++ b/platform/ios/scripts/release-notes-jazzy.md.ejs
@@ -0,0 +1,23 @@
+# [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/)
+
+The Mapbox Maps SDK for iOS is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS 9.0 and above using Objective-C, Swift, or Interface Builder. It takes stylesheets that conform to the [Mapbox Style Specification](https://www.mapbox.com/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/), and renders them using OpenGL.
+
+![Mapbox Maps SDK for iOS screenshots](img/screenshot.png)
+
+For setup information, check out the [Mapbox Maps SDK for iOS homepage](https://www.mapbox.com/ios-sdk/). For detailed usage instructions, read “[First steps with the Mapbox Maps SDK for iOS](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/).
+
+If you have any questions, please see [our help page](https://www.mapbox.com/help/). We welcome your [bug reports, feature requests, and contributions](https://github.com/mapbox/mapbox-gl-native/issues/).
+
+## Changes in version <%-CURRENTVERSION%>
+
+<%-CURRENTCHANGELOG%>
+
+## Recent changes
+
+<% OTHERRELEASES.forEach(function(release) { %>
+### <%-release.version%>
+
+<%-release.changelog%>
+<% }) -%>
+
+See the [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/ios-v<%-CURRENTVERSION%>/platform/ios/CHANGELOG.md) for previous releases.