Release 2.2.1

Author: tswaters

CHANGES.MD

@@ -1,4 +1,10 @@
 
+## 2.2.1
+
+* tons of internal refactors
+* adding typings file
+* added new method, `destroy` which removes the canvas and timers.
+
 ## 2.2.0
 
 * adding a kill method that forcibly kills the fireworks

README.MD

@@ -39,6 +39,20 @@ fireworks.kill() // forcibly stop fireworks
 fireworks.fire() // fire a single rocket.
 ```
 
+## usage with typscript
+
+```ts
+import * as FireworksCanvas from 'fireworks-canvas'
+const fireworks = new FireworksCanvas(container)
+```
+
+OR
+
+```ts
+import FireworksCanvas = require('fireworks-canvas')
+const fireworks = new FireworksCanvas(container)
+```
+
 ## support
 
 Requires es6 in the browser
@@ -47,7 +61,8 @@ Requires es6 in the browser
 
 ```sh
 npm i
-npm run build
-# open ./index.html in your favourite evergreen browser
+npm run build:dev
+# edit ./gh-pages/index.html, change reference to '../dist/fireworks.js`
+# open ./gh-pages/index.html in your favourite evergreen browser
 ```
 

fireworks.d.ts

@@ -0,0 +1,25 @@
+
+export as namespace Fireworks;
+
+declare class Fireworks2 {
+  constructor(container: HTMLElement, options?: Fireworks.FireworksOptions);
+  destroy(): void;
+  start(): () => void;
+  stop(): void;
+  kill(): void;
+  fire(): void;
+  update(): void;
+}
+
+declare namespace Fireworks {
+  export type FireworksOptions = {
+    maxRockets?: number
+    numParticles?: number
+    explosionMinHeight?: number
+    explosionMaxHeight?: number
+    explosionChance?: number
+    rocketSpawnInterval?: number
+  }
+}
+
+export default Fireworks