small update

Author: jwu

README.md

@@ -6,11 +6,9 @@ Yet another gl-matrix but smaller (without SIMD) and faster (use Hidden class in
 
 ## Why?
 
-  - Bug fixes compare to gl-matrix.
-  - More math methods compare to gl-matrix.
-  - Use row-major matrix for all calculation.
-  - Use hidden class compare to Float32Array for fast data access and fast create.
+  - Hidden classes + inline caching is much faster than Array/Float32Array.
   - Remove SIMD for smaller footprint.
+  - Make sure using the column-major matrix for all calculation.
 
 ## Install
 

dist/vmath.dev.js

@@ -1,16 +1,29 @@
 import { EPSILON } from './utils';
 
-// NOTE: we use row-major matrix
-// Where:
-
-// m00, m01, m02
-// m10, m11, m12
-// m20, m21, m22
-
-// The floats are laid out:
-// x | m0 | m1 | m2
-// y | m3 | m4 | m5
-// z | m6 | m7 | m8
+/**
+ * NOTE: we use column-major matrix for all matrix calculation.
+ *
+ * This may lead to some confusion when referencing OpenGL documentation,
+ * however, which represents out all matricies in column-major format.
+ * This means that while in code a matrix may be typed out as:
+ *
+ * [1, 0, 0, 0,
+ *  0, 1, 0, 0,
+ *  0, 0, 1, 0,
+ *  x, y, z, 0]
+ *
+ * The same matrix in the [OpenGL documentation](https://www.khronos.org/registry/OpenGL-Refpages/gl2.1/xhtml/glTranslate.xml)
+ * is written as:
+ *
+ *  1 0 0 x
+ *  0 1 0 y
+ *  0 0 1 z
+ *  0 0 0 0
+ *
+ * Please rest assured, however, that they are the same thing!
+ * This is not unique to glMatrix, either, as OpenGL developers have long been confused by the
+ * apparent lack of consistency between the memory layout and the documentation.
+ */
 
 class _mat3 {
   constructor(m00, m01, m02, m03, m04, m05, m06, m07, m08) {

dist/vmath.dev.js.map

@@ -1,18 +1,29 @@
 import { EPSILON } from './utils';
 
-// NOTE: we use row-major matrix
-// Where:
-
-// m00, m01, m02, m03
-// m10, m11, m12, m13
-// m20, m21, m22, m23
-// m30, m31, m32, m33
-
-// The floats are laid out:
-// x |  m0 |  m1 |  m2 |  m3
-// y |  m4 |  m5 |  m6 |  m7
-// z |  m8 |  m9 | m10 | m11
-// T | m12 | m13 | m15 | m15
+/**
+ * NOTE: we use column-major matrix
+ *
+ * This may lead to some confusion when referencing OpenGL documentation,
+ * however, which represents out all matricies in column-major format.
+ * This means that while in code a matrix may be typed out as:
+ *
+ * [1, 0, 0, 0,
+ *  0, 1, 0, 0,
+ *  0, 0, 1, 0,
+ *  x, y, z, 0]
+ *
+ * The same matrix in the [OpenGL documentation](https://www.khronos.org/registry/OpenGL-Refpages/gl2.1/xhtml/glTranslate.xml)
+ * is written as:
+ *
+ *  1 0 0 x
+ *  0 1 0 y
+ *  0 0 1 z
+ *  0 0 0 0
+ *
+ * Please rest assured, however, that they are the same thing!
+ * This is not unique to glMatrix, either, as OpenGL developers have long been confused by the
+ * apparent lack of consistency between the memory layout and the documentation.
+ */
 
 class _mat4 {
   constructor(

dist/vmath.js

@@ -1,11 +1,11 @@
 {
   "name": "vmath",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Yet another gl-matrix: faster and smaller",
   "main": "dist/vmath.js",
   "scripts": {
     "build": "rollup --config ./script/rollup.config.js",
-    "min": "uglifyjs ./dist/vmath.dev.js --source-map ./dist/vmath.min.js.map -o ./dist/vmath.min.js",
+    "min": "uglifyjs ./dist/vmath.dev.js --mangle --source-map ./dist/vmath.min.js.map -o ./dist/vmath.min.js",
     "release": "npm run build && npm run min",
     "test": "npm run build && tap test/*.spec.js"
   },