documentation, fixed package.json

CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.1] - 2019-01-11
+### Added
+- Documentation
+### Changed
+- Fixed format error in package.json
+- Renamed arguments in getQueryVariable()
+
 ## [1.0.0] - 2019-01-11
 ### Added
 - Inital commit

README.md

 # zkmtools
 
 Usefull things for JavaScript.
+
+## Documentation
+### blink( target, interval, duration )
+### getRandomInt( min, max )
+### getRandomArbitrary( min, max )
+### getMaxOfArray( numArray )
+### getMinOfArray( numArray)
+### getQueryVariable( variableName, fallbackValue )
+### setupPointerLock( target, callback )
+### FullscreenUtils()
+#### Static methods
+##### .toogle()
+Toggle between the fullscreen mode.
+##### .request()
+Request the element (_document_) to go fullscreen.
+##### .close()
+Close the fullscreen mode.

index.js

@@ -29,12 +29,12 @@ export function getMinOfArray( numArray ) {	// Min value inside an array
  return Math.min.apply( null, numArray );
 }
 
-export function getQueryVariable( variable, fallback ) {
+export function getQueryVariable( variableName, fallbackValue ) {
 	for( let vars of window.location.search.substring( 1 ).split( '&' ) ) {
 		let pair = vars.split( '=' );
-		if( pair[ 0 ] == variable ) return pair[ 1 ];
+		if( pair[ 0 ] == variableName ) return pair[ 1 ];
 	}
-	return fallback;
+	return fallbackValue;
 }
 
 export function setupPointerLock( target, callback ) {

package.json

 {
   "name": "zkmtools",
-  "version": "1.0.0",
-  "description": "Usefull tools for building javascript things",
+  "version": "1.0.1",
+  "description": "Useful tools for building javascript things",
   "main": "index.js",
   "repository": {
     "url": "https://hertz-gitlab.zkm.de/rapid-prototyping-lab/javascript-modules/zkmtools.git",
@@ -11,5 +11,5 @@
   "author": "Christian Lölkes",
   "license": "MIT",
   "dependencies": {},
-  "devDependencies": {},
+  "devDependencies": {}
 }