diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9f11b75 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea/ diff --git a/README.md b/README.md index eedb1cf..d08f7f1 100644 --- 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' +```