Skip to content

Commit

Permalink
Release v2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
tswaters committed Nov 18, 2018
1 parent 610f660 commit 853549c
Show file tree
Hide file tree
Showing 7 changed files with 719 additions and 350 deletions.
10 changes: 10 additions & 0 deletions CHANGES.MD
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@

## 2.3.0

Update build to use rollup, there are now 3 supported bunldes:

- fireworks.js - cjs module
- fireworks.mjs - es6 module
- fireworks.umd.js - browser umd bundle

The browser bundle now has a target of `es3` so it should support older browsers.

## 2.2.4

* OOF, forgot to run build on the last 2 releases.
Expand Down
18 changes: 12 additions & 6 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,14 @@ npm install --save fireworks-canvas
## usage

```js
// exports a standard umd boiler:

import * as Fireworks from 'fireworks-canvas' // mjs

const Fireworks = require('fireworks-canvas') // cjs
define(['fireworks-canvas'], (FireWorks) => {}) // amd
const Fireworks = window.Fireforks // browser global

define(['fireworks'], (Fireworks) => {}) // amd

const Fireworks = window.Fireworks // browser global

// needs at least a container element, you can provide options
// (options are optional, defaults defined below)
Expand Down Expand Up @@ -55,14 +59,16 @@ const fireworks = new FireworksCanvas(container)

## support

Requires es6 in the browser
Should work in most browsers.

Note that you'll need a polyfill for `Set` to support iexplore 11.

## development

```sh
npm i
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
# edit ./gh-pages/index.html, change reference to '../dist/fireworks.umd.js`
# open ./gh-pages/index.html in your favourite browser
```

Loading

0 comments on commit 853549c

Please sign in to comment.