From 73abfc3d08e84c805ea5b6cd60548bad665dbaed Mon Sep 17 00:00:00 2001
From: Mike Morris <michael.patrick.morris@gmail.com>
Date: Thu, 14 May 2015 11:40:18 -0400
Subject: [PATCH] update changelog and readme [skip ci]

- Document Node.js v0.12.x and io.js support
- Document map.release functionality.
- Add notes on garbage collection and request handling.
- Update binary platforms and build instructions.
- Document API token FileSource implementation from
  https://github.com/mapbox/mapbox-gl-native/pull/1607
- Update Kind enum values.
---
 CHANGELOG.md | 14 +++++++++++++
 README.md    | 55 +++++++++++++++++++++++++++++++++++++++++++---------
 2 files changed, 60 insertions(+), 9 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6d604b678..b8c40b946 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,17 @@
+# 1.1.0
+
+- Adds Node.js v0.12.x and io.js support.
+- Adds `map.release()` method for manual cleanup of map resources.
+- Fixes garbage collection of NodeMap objects.
+- Returns an error callback for failed NodeFileSource requests.
+- Fixes handling of corrupt NodeFileSource request data.
+- Implements request coalescing to fix NodeRequest cancellation.
+- Updates build scripts and Travis CI configuration.
+- Logs Environment ID and thread name when in an Environment scope.
+- Refactors NodeLog to implement mbgl::Log::Observer.
+- Fixes uncaught exception from missing sprites.
+- Fixes Unicode glyph range end.
+
 # 1.0.3
 
 - Fixes crash during garbage collection by assigning FileSource handle to a v8::Persistent in NodeMap constructor.
diff --git a/README.md b/README.md
index f554e4d1f..6f0285f86 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Renders map tiles with [Mapbox GL](https://github.com/mapbox/mapbox-gl-native).
 By default, installs binaries. On these platforms no external dependencies are needed.
 
 - 64 bit OS X or 64 bit Linux
-- Node v0.10.x
+- Node.js v0.10.x, Node.js v0.12.x, io.js v2.x
 
 Just run:
 
@@ -17,7 +17,7 @@ Just run:
 npm install mapbox-gl-native
 ```
 
-However, other platforms will fall back to a source compile with `make build`. To compile this module, make sure all submodules are initialized.
+However, other platforms will fall back to a source compile with `npm run build`. To compile this module, make sure all submodules are initialized with `git submodule update --init`.
 
 ## Rendering a map tile
 
@@ -46,6 +46,8 @@ The first argument passed to `map.render` is an options object, all keys are opt
 
 _More about classes: https://github.com/mapbox/mapbox-gl-js/blob/master/API.md#working-with-style-classes_
 
+When you are finished using a map object, you can call `map.release()` to dispose the internal map resources manually. This is not necessary, but can be helpful to optimize resource usage (memory, file sockets) on a more granualar level than v8's garbage collector.
+
 ## Testing
 
 ```
@@ -83,10 +85,12 @@ The `kind` is an enum and defined in `mbgl.Resource`:
 ```json
 {
     "Unknown": 0,
-    "Tile": 1,
-    "Glyphs": 2,
-    "Image": 3,
-    "JSON": 4
+    "Style": 1,
+    "Source": 2,
+    "Tile": 3,
+    "Glyphs": 4,
+    "JSON": 5,
+    "Image": 6
 }
 ```
 
@@ -110,7 +114,7 @@ This is a very barebones implementation and you'll probably want a better implem
     modified: new Date(),
     expires: new Date(),
     etag: "string",
-    data: new Buffer(),
+    data: new Buffer()
 };
 ```
 
@@ -156,12 +160,45 @@ Note that in reality, Mapbox GL uses two types of protocols: `asset://` for file
 
 ## Mapbox API Access tokens
 
-To use styles that rely on Mapbox vector tiles, you must register a [API access token](https://www.mapbox.com/developers/api/#access-tokens) on the map. Use the `setAccessToken` method before load:
+To use styles that rely on Mapbox vector tiles, you must pass an [API access token](https://www.mapbox.com/developers/api/#access-tokens) in your `FileSource` implementation with requests to `mapbox://` protocols.
 
 ```js
+var mbgl = require('mapbox-gl-native');
+var request = require('request');
+var url = require('url');
+
+var fileSource = new mbgl.FileSource();
+fileSource.request = function(req) {
+    var opts = {
+        url: req.url,
+        encoding: null,
+        gzip: true
+    };
+
+    if (url.parse(req.url).protocol === 'mapbox:') {
+        opts.qs = { access_token: process.env.MAPBOX_ACCESS_TOKEN};
+    }
+
+    request(opts, function (err, res, body) {
+        if (err) {
+            req.respond(err);
+        } else if (res.statusCode == 200) {
+            var response = {};
+
+            if (res.headers.modified) { response.modified = new Date(res.headers.modified); }
+            if (res.headers.expires) { response.expires = new Date(res.headers.expires); }
+            if (res.headers.etag) { response.etag = res.headers.etag; }
+            response.data = body;
+            req.respond(null, response);
+        } else {
+            req.respond(new Error(JSON.parse(body).message));
+        }
+    });
+}
+
 var map = mbgl.Map(fileSource);
 var style = mapboxStyle; // includes a datasource with a reference to something like `mapbox://mapbox.mapbox-streets-v6`
-map.setAccessToken(process.env.MAPBOX_ACCESS_TOKEN);
+
 map.load(style);
 map.render({}, function(err, image) {
     if (err) throw err;