From d89b58ec510220acb8dd8c7865ee51878a398f34 Mon Sep 17 00:00:00 2001 From: ycw Date: Thu, 15 Oct 2020 09:32:43 +0800 Subject: [PATCH] updated ctor api doc --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ce141ab..66db84d 100644 --- 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`.