Merge remote-tracking branch 'Automattic/master' into static

.travis.yml

@@ -4,7 +4,6 @@ node_js:
   - '4'
   - '0.12'
   - '0.10'
-  - '0.8'
 addons:
   apt:
     sources:
@@ -18,6 +17,5 @@ addons:
 env:
   - CXX=g++-4.9
 before_install:
-  - if [[ $TRAVIS_NODE_VERSION == 0.8 ]]; then npm install -g [email protected]; fi
   - npm explore npm -g -- npm install node-gyp@latest
 sudo: false

History.md

@@ -1,3 +1,8 @@
+1.6.0 / 2016-10-16
+==================
+
+ * Support canvas.getBuffer('raw') (#819)
+
 1.5.0 / 2016-09-11
 ==================
 

Readme.md

@@ -1,5 +1,13 @@
-node-canvas
-===========
+# node-canvas
+
+-----
+
+## This is the documentation for the unreleased version 2.0
+
+**For the current version 1.x documentation, see [the v1.x branch](https://github.com/Automattic/node-canvas/tree/v1.x)**
+
+-----
+
 ### Canvas graphics API backed by Cairo
 [![Build Status](https://travis-ci.org/Automattic/node-canvas.svg?branch=master)](https://travis-ci.org/Automattic/node-canvas)
 [![NPM version](https://badge.fury.io/js/canvas.svg)](http://badge.fury.io/js/canvas)
@@ -19,16 +27,18 @@ node-canvas
 $ npm install canvas
 ```
 
-Unless previously installed you'll _need_ __Cairo__. For system-specific installation view the [Wiki](https://github.com/Automattic/node-canvas/wiki/_pages).
+Unless previously installed you'll _need_ __Cairo__ and __Pango__. For system-specific installation view the [Wiki](https://github.com/Automattic/node-canvas/wiki/_pages).
+
+Currently the minimum version of node required is __0.10.0__
 
 You can quickly install the dependencies by using the command for your OS:
 
 OS | Command
 ----- | -----
-OS X | `brew install pkg-config cairo libpng jpeg giflib`
+OS X | `brew install pkg-config cairo pango libpng jpeg giflib`
 Ubuntu | `sudo apt-get install libcairo2-dev libjpeg8-dev libpango1.0-dev libgif-dev build-essential g++`
 Fedora | `sudo yum install cairo cairo-devel cairomm-devel libjpeg-turbo-devel pango pango-devel pangomm pangomm-devel giflib-devel`
-Solaris | `pkgin install cairo pkg-config xproto renderproto kbproto xextproto`
+Solaris | `pkgin install cairo pango pkg-config xproto renderproto kbproto xextproto`
 Windows | [Instructions on our wiki](https://github.com/Automattic/node-canvas/wiki/Installation---Windows)
 
 **El Capitan users:** If you have recently updated to El Capitan and are experiencing trouble when compiling, run the following command: `xcode-select --install`. Read more about the problem [on Stack Overflow](http://stackoverflow.com/a/32929012/148072).
@@ -140,10 +150,22 @@ var stream = canvas.jpegStream({
 
 ### Canvas#toBuffer()
 
-A call to `Canvas#toBuffer()` will return a node `Buffer` instance containing all of the PNG data.
+A call to `Canvas#toBuffer()` will return a node `Buffer` instance containing image data.
 
 ```javascript
-canvas.toBuffer();
+// PNG Buffer, default settings
+var buf = canvas.toBuffer();
+
+// PNG Buffer, zlib compression level 3 (from 0-9), faster but bigger
+var buf2 = canvas.toBuffer(undefined, 3, canvas.PNG_FILTER_NONE);
+
+// ARGB32 Buffer, native-endian
+var buf3 = canvas.toBuffer('raw');
+var stride = canvas.stride;
+// In memory, this is `canvas.height * canvas.stride` bytes long.
+// The top row of pixels, in ARGB order, left-to-right, is:
+var topPixelsARGBLeftToRight = buf3.slice(0, canvas.width * 4);
+var row3 = buf3.slice(2 * canvas.stride, 2 * canvas.stride + canvas.width * 4);
 ```
 
 ### Canvas#toBuffer() async
@@ -170,6 +192,26 @@ canvas.toDataURL('image/jpeg', {opts...}, function(err, jpeg){ }); // see Canvas
 canvas.toDataURL('image/jpeg', quality, function(err, jpeg){ }); // spec-following; quality from 0 to 1
 ```
 
+### Canvas.registerFont for bundled fonts
+
+It can be useful to use a custom font file if you are distributing code that uses node-canvas and a specific font. Or perhaps you are using it to do automated tests and you want the renderings to be the same across operating systems regardless of what fonts are installed.
+
+To do that, you should use `Canvas.registerFont`.
+
+**You need to call it before the Canvas is created**
+
+```javascript
+Canvas.registerFont('comicsans.ttf', {family: 'Comic Sans'});
+
+var canvas = new Canvas(500, 500),
+  ctx = canvas.getContext('2d');
+
+ctx.font = '12px "Comic Sans"';
+ctx.fillText(250, 10, 'Everyone hates this font :(');
+```
+
+The second argument is an object with properties that resemble the CSS properties that are specified in `@font-face` rules. You must specify at least `family`. `weight`, and `style` are optional (and default to "normal").
+
 ### CanvasRenderingContext2D#patternQuality
 
 Given one of the values below will alter pattern (gradients, images, etc) render quality, defaults to _good_.
@@ -298,16 +340,6 @@ Visual tests:
 
     $ make test-server
 
-## Versions
-
-Tested with and designed for:
-
-  - node 0.4.2
-  - cairo 1.8.6
-
-For node 0.2.x `node-canvas` <= 0.4.3 may be used,
-0.5.0 and above are designed for node 0.4.x only.
-
 ## License
 
 (The MIT License)