diff -r 3d62ad46d744 -r 36dce152ef80 javaquery/canvas/src/main/resources/net/java/html/canvas/package.html --- a/javaquery/canvas/src/main/resources/net/java/html/canvas/package.html Thu Sep 26 14:26:58 2013 -0700 +++ b/javaquery/canvas/src/main/resources/net/java/html/canvas/package.html Tue Feb 18 11:01:08 2014 +0100 @@ -20,5 +20,16 @@ Universal, flexible, capable, effective, highly efficient Canvas API for any device on the planet (and beyond). + The purpose of this API is to create a common interface for drawing to a canvas using Java. Currently there are implementations for JavaFX Canvas and for + HTML 5 Canvas. You can choose your implementation depending on the availability on your target platform and performance + requirements. + + The entry point is the GraphicsUtils class. It gives you access to the GraphicsContext that you can use to draw. + Currently you need to pass in a GraphicsEnvironment: + // JavaFX implementation available here https://github.com/eppleton/FXGameEngine + GraphicsContext gc = GraphicsUtil.create(new JavaFXGraphicsEnvironment()); + + +