Package Exports

browser-sync
browser-sync/bin/browser-sync
browser-sync/lib/browser-sync
browser-sync/lib/public/init
browser-sync/lib/server/utils
browser-sync/lib/templates/script-tags.tmpl
browser-sync/package
browser-sync/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (browser-sync) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

BrowserSync

Keep multiple browsers & devices in sync when building websites.

BrowserSync is developed and maintained internally at JH, follow @BrowserSync on twitter for news & updates.

Features

Please visit browsersync.io for a full run-down of features

Requirements

BrowserSync works by injecting an asynchronous script tag (<script async>...</script>) right after the <body> tag during initial request. In order for this to work properly the <body> tag must be present. Alternatively you can provide a custom rule for the snippet using snippetOptions

Upgrading from 1.x to 2.x ?

Providing you havn't accessed any internal properties, everything will just work as there are no breaking changes to the public API. Internally however, we now use an immutable data structure for storing/retrieving options. So whereas before you could access urls like this...

browserSync({server: true}, function(err, bs) {
    console.log(bs.options.urls.local);
});

... you now access them in the following way:

browserSync({server: true}, function(err, bs) {
    console.log(bs.options.getIn(["urls", "local"]);
});

Install

npm install -g browser-sync

How to use it

Using Grunt?

There's a separate plugin for that

Using Gulp?

No problem, here's a setup guide

Using Brunch?

Enjoy the browser-sync-brunch plugin

Support

If you've found Browser-sync useful and would like to contribute to its continued development & support, please feel free to send a donation of any size - it would be greatly appreciated!

Contributors

   792	Shane Osbourne
    33	Shinnosuke Watanabe
    19	Shane Daniel
    13	Hugo Bessa
    11	Paul Kinlan
     8	shinnn
     4	Matt Green
     3	Adam Lynch
     3	Marek 'saji' Augustynowicz
     3	Werner van Deventer
     2	Dan Tello
     2	Michael Branch
     2	Olivier Combe
     2	Hugo Dias
     2	brutaldev
     2	chase_chou
     2	Paul Robertson
     2	Eugeny Vlasenko
     2	Piotr Kaleta
     1	Sylvain Emery
     1	Tony Holdstock-Brown
     1	Victor Fernandez de Alba
     1	viktor hesselbom
     1	Yazhong Liu
     1	mericson
     1	Dave Hall
     1	Guillaume Lambert
     1	Jory Graham
     1	Benjamín Eidelman
     1	Craig Morris
     1	Peter Blazejewicz
     1	Robert Vock
     1	Cedric Kastner
     1	Carl Henderson
     1	Cameron Spear

browser-sync