fixes #1503: add changelog w/ notes to appledoc index

ios/README.md

@@ -0,0 +1,5 @@
+# Mapbox GL for iOS
+
+An open source OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa bindings.
+
+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

@@ -103,6 +103,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}" \
@@ -111,4 +116,6 @@ appledoc \
     --no-create-docset \
     --no-install-docset \
     --company-id com.mapbox \
+    --ignore include/mbgl/ios/private \
+    --index-desc ${README} \
     include/mbgl/ios