ld31-space-diggers/node_modules/browser-sync/README.md
Ruben Müller 760c1838ed Add game
2014-12-07 20:57:49 +01:00

4.4 KiB

BrowserSync ![Build status] (https://ci.appveyor.com/api/projects/status/r5vung2ipn9uj4sy) [Build Status] (https://travis-ci.org/shakyShane/browser-sync) Coverage Status NPM version

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

  1. Scroll - I can keep your pages in sync when scrolling.
  2. Forms - You fill out a form in one browser, I'll copy the data to all the others.
  3. Links - I'll watch your clicks and make all the other browsers follow you.
  4. CSS injecting - I can even watch your CSS files & inject them when they change.
  5. Live Reload - I can also watch files like HTML and PHP & when they change I can reload all browsers for you.
  6. Built-in Server - Yep, I can serve static files too if you need me to (uses Connect).
  7. Use with any back-end setup - I even have a proxy option so that I can be used with existing PHP, Rails, Python, Node or ASP.net setup.
  8. Public URL - View your website via a URL that any internet connected device can access & maintain all BrowserSync features.
  9. Browser Stack support - Use the all of my features when viewing your site through Browser Stack.

##When is it useful? It's pretty useful when used with a single browser, watching a CSS file for changes & injecting it. But the real power comes when you're building responsive sites and using multiple devices/monitors because it can keep all browsers in sync & make your workflow much faster.

##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

##Install

npm install -g browser-sync

##How to use it

  1. Command line
  2. API

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

Screencasts

Some listed here Want any more? Something specific? ask me nicely @shaneOsbourne

##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!

Support via Gittip Support via PayPal

Contributors

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

License

Copyright (c) 2014 Shane Osbourne Licensed under the GPL license.