From 834e59722c81de924fbcabc3e800c81da4a53405 Mon Sep 17 00:00:00 2001
From: "Justin R. Miller" <incanus@codesorcery.net>
Date: Mon, 11 May 2015 13:01:09 -0700
Subject: [PATCH] fixes #1503: add changelog w/ notes to appledoc index

---
 ios/README.md            |  5 +++++
 ios/docs/install_docs.sh | 15 +++++++++++----
 ios/docs/remove_docs.sh  |  2 +-
 scripts/ios/package.sh   |  7 +++++++
 4 files changed, 24 insertions(+), 5 deletions(-)
 create mode 100644 ios/README.md

diff --git a/ios/README.md b/ios/README.md
new file mode 100644
index 000000000..169da5ff8
--- /dev/null
+++ b/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/). 
diff --git a/ios/docs/install_docs.sh b/ios/docs/install_docs.sh
index df1d366e6..7d4bf279f 100755
--- a/ios/docs/install_docs.sh
+++ b/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
diff --git a/ios/docs/remove_docs.sh b/ios/docs/remove_docs.sh
index 09e2c1d39..747ca0a3a 100755
--- a/ios/docs/remove_docs.sh
+++ b/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..."
diff --git a/scripts/ios/package.sh b/scripts/ios/package.sh
index 675e31d57..35162ce5d 100755
--- a/scripts/ios/package.sh
+++ b/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