updated ctor api doc

ycw · Oct 15, 2020 · d89b58e · d89b58e
1 parent 3a96160
commit d89b58e
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -49,7 +49,10 @@ Live result: [Basic Subtract](https://ycw.github.io/three-csg-modeller/examples/
 
 ## API
 
-### `Modeller`
+### `CSGModeller`
+
+`new CSGModeller(THREE)`
+- Construct a modeller. `THREE` is the three.js lib.
 
 `.model(mesh)`
 - Create a `Model` instance from a mesh whose `.geometry` must be a `BufferGeometry`.