Update readme and add gitignore

dividab · Apr 12, 2016 · a3a2ccc · a3a2ccc
1 parent de0d8eb
commit a3a2ccc
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.idea/
diff --git a/README.md b/README.md
@@ -1,3 +1,20 @@
 # three-x3d-loader
 
-ThreeJS Loader for the X3D format.
+> Three.js Loader for the X3D format.
+
+## Install
+
+```
+$ npm install --save three-x3d-loader
+```
+
+## Usage
+
+```js
+var THREE = require('three');
+var X3DLoader = require('three-x3d-loader');
+X3DLoader(THREE);
+
+console.log(typeof THREE.X3DLoader);
+//=> 'function'
+```