Merge pull request #1508 from mapbox/1503-add-changelog

refs #1503: add changelog to appledoc

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.3.0
+
+- Initial iOS beta release. 
+
+Known issues: 
+
+- None. 

ios/README.md

@@ -1,68 +1,5 @@
 # Mapbox GL for iOS
 
-Use or edit this project to get access to vector maps (via [Mapbox Vector Tiles](https://www.mapbox.com/blog/vector-tiles)) and dynamic OpenGL-based styling in your iOS apps by using `MGLMapView`. 
+An open source OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa bindings.
 
-![](./screenshot.png)
-
-## Installation
-
-Currently in flux. See the parent `mapbox-gl-native` project `README` for details on building this library yourself. 
-
-Static and dynamic prebuilt binaries are coming back, as is CocoaPods support. 
-
-## Example usage
-
-### Objective-C
-
-```objective-c
-MGLMapView *mapView = [[MGLMapView alloc] initWithFrame:CGRectMake(0, 0, 400, 400)
-                                            accessToken:@"<access token string>"];
-
-[mapView setCenterCoordinate:CLLocationCoordinate2DMake(28.369334, -80.743779) 
-                   zoomLevel:13 
-                    animated:NO];
-
-[mapView useBundledStyleNamed:@"outdoors"];
-
-[self.view addSubview:mapView];
-```
-
-### Swift
-
-```swift
-let mapView = MGLMapView(frame: CGRect(x: 0, y: 0, width: 400, height: 400),
-                         accessToken: "<access token string>")
-
-mapView.setCenterCoordinate(CLLocationCoordinate2D(latitude: 46.049900, longitude: -122.095678),
-        zoomLevel: 12,
-        animated: false)
-
-mapView.useBundledStyleNamed("outdoors")
-
-view.addSubview(mapView)
-```
-
-## Development
-
-If you'd like to contribute to this project, go up to [Mapbox GL native](https://github.com/mapbox/mapbox-gl-native) and clone the project. 
-
-## Testing
-
-Currently in flux and not functioning. 
-
-## Requirements
-
- * iOS 7+
- * a sense of adventure
-
-## Styling
-
-See the [online style reference](https://www.mapbox.com/mapbox-gl-style-spec/) for the latest documentation. Contained within the `MapboxGL.bundle` assets are a couple of starter styles in JSON format. 
-
-The project will eventually get a programmatic styling API as well. 
-
-## Related Projects
-
- * https://github.com/mapbox/mapbox-gl-style-spec
- * https://github.com/mapbox/mapbox-gl-js
- * https://github.com/mapbox/vector-tile-spec
+For more information, check out [our online overview](https://www.mapbox.com/mapbox-gl-ios/). 

ios/docs/install_docs.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
 
 if [ -z `which appledoc` ]; then
     echo "Unable to find appledoc. Consider installing it from source or Homebrew."
@@ -8,14 +8,21 @@ fi
 OUTPUT="/tmp/`uuidgen`"
 
 VERSION=$( git tag -l ios\* --sort -v:refname | sed -n '1p' | sed 's/ios-v//' )
-echo "Creating new docs for $VERSION..."
+echo "Creating new docs for ${VERSION}..."
 echo
 
+README="/tmp/GL-README.md"
+cat ../README.md > ${README}
+echo >> ${README}
+echo -n "#" >> ${README}
+cat ../../CHANGELOG.md >> ${README}
+
 appledoc \
-    --output $OUTPUT \
-    --project-name "Mapbox GL for iOS $VERSION" \
+    --output ${OUTPUT} \
+    --project-name "Mapbox GL for iOS ${VERSION}" \
     --project-company Mapbox \
     --create-docset \
     --company-id com.mapbox \
     --ignore ../../include/mbgl/ios/private \
+    --index-desc ${README} \
     ../../include/mbgl/ios

ios/docs/remove_docs.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
 
 echo
 echo "Removing docs from ~/Library/Developer/Shared/Documentation/DocSets..."

scripts/ios/package.sh

@@ -105,6 +105,11 @@ if [ -z `which appledoc` ]; then
 fi
 DOCS_OUTPUT="${OUTPUT}/static/Docs"
 DOCS_VERSION=$( git tag -l ios\* --sort -v:refname | sed -n '1p' | sed 's/ios-v//' )
+README="/tmp/GL-README.md"
+cat ios/README.md > ${README}
+echo >> ${README}
+echo -n "#" >> ${README}
+cat CHANGELOG.md >> ${README}
 appledoc \
     --output ${DOCS_OUTPUT} \
     --project-name "Mapbox GL for iOS ${DOCS_VERSION}" \
@@ -113,4 +118,6 @@ appledoc \
     --no-create-docset \
     --no-install-docset \
     --company-id com.mapbox \
+    --ignore include/mbgl/ios/private \
+    --index-desc ${README} \
     include/mbgl/ios