README.md

Surfboard

Widget to bring the Migme fun to web apps.

Installation

NPM

npm install migme-surfboard

CDN

Replace ${VERSION} with a released version number.

<script src="https://cdn.rawgit.com/migme/surfboard/releases/download/${VERSION}/migme-surfboard.min.js"></script>

Usage

Loading

// ES6
import Surfboard from 'migme-surfboard'

// CommonJS
var Surfboard = require('migme-surfboard')

// AMD
define(['migme-surfboard'], function (Surfboard) {
  // ...
})

Initialization

const widget = new Surfboard()

Development

# Install dependencies
npm install

# Run tests (continuous integration)
npm test

# Run tests (development)
karma start
# ... sans code coverage for clean source maps
# See: douglasduteil/isparta#31
karma start --coverage false

# Build
gulp browserify
# ... forever
gulp watchify

Live Demo

npm i -g http-server
http-server
open http://127.0.0.1:8080