diff --git a/README.md b/README.md index 36ad79b..74353c9 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,30 @@ done! ## Options | Attribute | Description | Example value | Default value | -|---------------------------|-------------|---------------|---------| +|---------------------------|-------------|--------------------|---------| | *`target`* | The Id tag of the canvas that will be used | 'my-canvas' | 'confetti-holder' | +| *`max`* | The number of props(confetti) to be rendered | 11 | 80 | +| *`animate`* | If the confetti should fall | false | true | +| *`clock`* | The speed confetti fall | 50 | 25 | +| *`props`* | The type of props(confetti) that should be rendered. All the available are at the default. | ['circle', 'square'] | ['circle', 'square', 'triangle', 'line'] | +| *`colors`* | The color to be rendered on the confetti. By default, RGB format inside an array. | [[0,0,0], [255,255,255]] | [[165,104,246],[230,61,135],[0,199,228],[253,214,126]] | + +## API +Using the object generated by `new ConfettiGenerator()` is pretty easy, there're just two main methods actually. + +| Method | Description | +|---------------------------|-------------| +| *`render`* | Render the confetti at the config `` | +| *`clear`* | Clear the `` where the confetti where rendered | + +```javascript + +``` ## License to-do