rdrew
1440706ce3
|
6 years ago | |
---|---|---|
.. | ||
certs | 6 years ago | |
cli-options | 6 years ago | |
client | 6 years ago | |
dist | 6 years ago | |
templates | 6 years ago | |
CHANGELOG.md | 6 years ago | |
LICENSE | 6 years ago | |
README.md | 6 years ago | |
changelog.js | 6 years ago | |
package.json | 6 years ago |
README.md
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 haven'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 and trouble shooting
Integrations / recipes
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!
Apache 2 Copyright (c) 2016 Shane Osbourne