Skip to content

Commit 1871d1b

Browse files
committed
Update README.
1 parent acf37c2 commit 1871d1b

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# node-openvg-canvas
2+
3+
[![NPM](https://nodei.co/npm/openvg-canvas.png?downloads=true&stars=true)](https://nodei.co/npm-dl/openvg-canvas/) [![NPM](https://nodei.co/npm-dl/openvg-canvas.png)](https://nodei.co/npm-dl/openvg-canvas/)
4+
25
## Canvas implementation on node-openvg
36

47
This module implements a HTML5 Canvas on top of OpenVG (node-openvg). It is targeted to the raspberry-pi.
@@ -10,7 +13,9 @@ Currently there are only plans to implement the 2d context. Implementing the 3d
1013

1114
## 0. Installation
1215

13-
This module is targeted for node 0.8.x. Node >= 0.8.10 will compile out of the box on the raspberry. For building instructions please refer to this [gist](https://gist.github.com/3245130).
16+
This module has been tested on node 0.8, 0.10 and 0.11. Official node binaries for the
17+
raspberry pi can be found be clicking at "Other release files" link that accompanies every
18+
node release announcement, [example](http://nodejs.org/dist/v0.11.4/).
1419

1520
### Prerequisites
1621

@@ -37,17 +42,9 @@ To test:
3742

3843
### NPM / module install
3944

40-
Either run on your command line:
41-
42-
npm install openvg-canvas
43-
44-
or add it to your package.json:
45+
Run on your command line:
4546

46-
[...]
47-
"dependencies": {
48-
"openvg-canvas" : "1.1.0"
49-
},
50-
[...]
47+
npm install openvg-canvas --save
5148

5249
## 1. Documentation
5350

@@ -123,7 +120,7 @@ On browsers, the Canvas rendering is controlled by the browser runtime - this is
123120

124121
On node-canvas, user code explicitly calls toBuffer or similar functions to produce output. Note that this behavior can be reproduced on node-openvg-canvas by calling ImageData.saveToBuffer and/or Canvas.toBuffer.
125122

126-
Code running on node-openvg-canvas must explicitly swap display buffers, to do so, either call ```Canvas.vgSwapBuffers()``` or use the included requestAnimationFrame shim (for more information look at the clock examples) that does this after calling your paint (callback) function.
123+
Code running on node-openvg-canvas must explicitly swap display buffers, to do so, either call ```Canvas.vgSwapBuffers()``` or use the included requestAnimationFrame shim that does this after calling your paint callback function (for more information look at the clock examples).
127124

128125
## License
129126

0 commit comments

Comments
 (0)