Merge pull request #97 from mapbox/document-options

document render options
mapbox · Mar 4, 2015 · a8cf26a · a8cf26a
2 parents 848fa66 + ae4831d
commit a8cf26a
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,20 @@ map.render({}, function(err, image) {
 });
 ```
 
+The first argument passed to `map.render` is an options object, all keys are optional:
+
+```js
+{
+    zoom: {zoom}, // number, defaults to 0
+    width: {width}, // number (px), defaults to 256
+    height: {height}, // number (px), defaults to 256
+    latitude: {latitude}, // number (coordinate), defaults to 0
+    longitude: {longitude}, // number (coordinate), defaults to 0
+    bearing: {bearing}, // number (degree), defaults to 0
+    ratio: {ratio} // number (scale factor), defaults to 1.0
+}
+```
+
 ## Testing
 
 ```