diff --git a/readme.md b/readme.md index b04d943..0de469b 100644 --- a/readme.md +++ b/readme.md @@ -31,6 +31,22 @@ Note that the compatibility will most likely be increased in future builds, as m There are still a lot of CSS properties missing, including most CSS3 properties such as text-shadow, box-radius etc. as well as all elements created by the browser, such as radio and checkbox buttons and list icons. I will compile a full list of supported elements and CSS properties soon. There is no support for frame and object content such as Flash. +### Usage ### +To render an `element` with html2canvas, simply call: +` html2canvas( [ element ], options);` + +To access the created canvas, provide the `onrendered` event in the options which returns the canvas element as the first argument, as such: + + html2canvas( [ document.body ], { + onrendered: function( canvas ) { + /* canvas is the actual canvas element, + to append it to the page call for example + document.body.appendChild( canvas ); + */ + } + ); + + ### Examples ### For more information and examples, please visit the homepage or try the test console. @@ -39,7 +55,7 @@ For more information and examples, please visit the niklasvh) * Radial gradients (SunboX) * Split renderers to their own objects (niklasvh) * Simplified API, cleaned up code (niklasvh)