webgl-raub - npm Package Compare versions

Comparing version 2.0.4 to 2.0.5

package.json

 {
 	"author": "Luis Blanco <[e-mail]>",
 	"name": "webgl-raub",
-	"version": "2.0.4",
+	"version": "2.0.5",
 	"description": "WebGL for Node.js",
@@ -44,6 +44,6 @@ "license": "MIT",
 	"dependencies": {
-		"addon-tools-raub": "5.0.0",
-		"deps-opengl-raub": "3.0.0",
-		"segfault-raub": "1.1.0"
+		"addon-tools-raub": "5.1.0",
+		"deps-opengl-raub": "3.0.1",
+		"segfault-raub": "1.1.1"
 	}
 }

README.md

@@ -10,3 +10,3 @@ # WebGL for Node.js
 
-> npm i glfw-raub
+> npm i webgl-raub
 
@@ -24,10 +24,12 @@
 
-[WebGLRenderingContext docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext)
+This module **does not provide** a window control system, and it
+**can not set up an OpenGL context** on its own. This API simply maps the
+native OpenGL function calls to their JS counterpart.
 
+**TL;DR**: see [3d-core-raub](https://github.com/node-3d/3d-core-raub)
+for a quick start in a fully sufficient environment.
 
+
 ## Usage
 
-> Note: see [3d-core-raub](https://github.com/node-3d/3d-core-raub)
-for a quick start in a fully sufficient environment.
-
 ```js
@@ -37,15 +39,13 @@ const webgl = require('webgl-raub');
 
-Here `webgl` is what contains all the **WebGL** api - `WebGLRenderingContext`.
-However a window is required to exercise your **GL** skills on. There is
-[a nice implementation](https://github.com/raub/node-glfw) for that,
-though different ones are quite possible.
-
-As soon as you create and set up a window, simply follow the
+Here `webgl` contains all the **WebGL** API, like a `WebGLRenderingContext` instance would.
+See
 [WebGLRenderingContext docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext).
 
-> Note: if you are planning to use browser **WebGL** libs, be aware of their browser-affinity.
-You would have to provide several additional interfaces to mimic the browser.
-There is [node-glfw](https://github.com/raub/node-glfw) module, which exports the
-`Document` class. It can be used the following way:
+To use browser **WebGL** libs, like [three.js](https://threejs.org/),
+several additional interfaces must also be provided to mimic the browser.
 
+There is [node-glfw](https://github.com/raub/node-glfw) module, which solves both
+window handling and additional browser-like interfaces. It is also bundled into
+the [3d-core-raub](https://github.com/node-3d/3d-core-raub) module, for that matter.
+
 ```
@@ -64,3 +64,11 @@ const webgl = require('webgl-raub');
 
+> OSX Note: some features may depend on OpenGL profile being used. Core profile
+is necessary for VAO and other OpenGL 3.2+ features. Depending on your windowing
+backend, set the OpenGL profile of your preference.
+In case [glfw-raub](https://github.com/raub/node-glfw) is used,
+the profile can be set through the `Window`/`Document`
+[constructor](https://github.com/node-3d/glfw-raub#class-window) or with
+`glfw.windowHint` calls.
 
+
 ---
@@ -77,2 +85,2 @@
 a far better option: [node-3d-core](https://github.com/raub/node-3d-core),
-which gets you two more steps ahead for free.
+which gets you two steps ahead for free.

No alert changes

Improved metrics

Total package byte prevSize

25564

increased by1.5%

Number of lines in readme file

82

increased by10.81%

Dependency changes

• + Addedaddon-tools-raub@5.1.0(transitive)

• + Addedadm-zip@0.4.14(transitive)

• + Addeddeps-opengl-raub@3.0.1(transitive)

• + Addednode-addon-api@2.0.0(transitive)

• + Addedsegfault-raub@1.1.1(transitive)

• - Removedaddon-tools-raub@5.0.0(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbig-integer@1.6.52(transitive)

• - Removedbinary@0.3.0(transitive)

• - Removedbluebird@3.4.7(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedbuffer-indexof-polyfill@1.0.2(transitive)

• - Removedbuffers@0.1.1(transitive)

• - Removedchainsaw@0.1.0(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removedcore-util-is@1.0.3(transitive)

• - Removeddeps-opengl-raub@3.0.0(transitive)

• - Removedduplexer2@0.1.4(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedfstream@1.0.12(transitive)

• - Removedglob@7.2.3(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedinflight@1.0.6(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedisarray@1.0.0(transitive)

• - Removedlistenercount@1.0.1(transitive)

• - Removedminimatch@3.1.2(transitive)

• - Removedminimist@1.2.8(transitive)

• - Removedmkdirp@0.5.6(transitive)

• - Removednode-addon-api@1.7.1(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedprocess-nextick-args@2.0.1(transitive)

• - Removedreadable-stream@2.3.8(transitive)

• - Removedrimraf@2.7.1(transitive)

• - Removedsafe-buffer@5.1.2(transitive)

• - Removedsegfault-raub@1.1.0(transitive)

• - Removedsetimmediate@1.0.5(transitive)

• - Removedstring_decoder@1.1.1(transitive)

• - Removedtraverse@0.3.9(transitive)

• - Removedunzipper@0.10.5(transitive)

• - Removedutil-deprecate@1.0.2(transitive)

• - Removedwrappy@1.0.2(transitive)

• Updatedaddon-tools-raub@5.1.0

• Updateddeps-opengl-raub@3.0.1

• Updatedsegfault-raub@1.1.1