Skip to content

Commit 53f9b36

Browse files
shakyShaneshakyShane
committed
docs: readme
1 parent 0b3d98b commit 53f9b36

3 files changed

Lines changed: 73 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,4 @@ If you've found Browser-sync useful and would like to contribute to its continue
6969

7070

7171
Apache 2
72-
Copyright (c) 2016 Shane Osbourne
72+
Copyright (c) 2019 Shane Osbourne

‎packages/browser-sync/lib/server/serve-static-wrapper.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,5 @@ export default function() {
88
const send = require("send");
99
send.mime.define({ "application/wasm": ["wasm"] });
1010

11-
1211
return serveStatic;
1312
}

‎packages/browser-sync/readme.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<p align="center">
2+
<a href="https://ci.appveyor.com/project/shakyShane/browser-sync" title="AppVeyor branch">
3+
<img src="https://img.shields.io/appveyor/ci/shakyshane/browser-sync/master.svg?style=flat-square&label=windows" />
4+
</a><a href="https://travis-ci.org/BrowserSync/browser-sync" title="Travis branch">
5+
<img src="https://img.shields.io/travis/BrowserSync/browser-sync/master.svg?style=flat-square&label=linux" />
6+
</a><a href="https://www.npmjs.com/package/browser-sync">
7+
<img src="https://img.shields.io/npm/dm/browser-sync.svg?style=flat-square" />
8+
</a>
9+
</p>
10+
<p align="center">
11+
<a href="https://www.npmjs.com/package/browser-sync" title="NPM version">
12+
<img src="https://img.shields.io/npm/v/browser-sync.svg?style=flat-square" />
13+
</a><a href="https://david-dm.org/Browsersync/browser-sync" title="Dependency Status">
14+
<img src="https://img.shields.io/david/Browsersync/browser-sync.svg?style=flat-square&label=deps" />
15+
</a>
16+
<a href="https://david-dm.org/Browsersync/browser-sync#info=devDependencies" title="devDependency Status">
17+
<img src="https://img.shields.io/david/dev/Browsersync/browser-sync.svg?style=flat-square&label=devDeps" />
18+
</a>
19+
</p>
20+
<p align="center"><a href="https://www.browsersync.io"><img src="https://raw.githubusercontent.com/BrowserSync/browsersync.github.io/master/public/img/logo-gh.png" /></a></p>
21+
<p align="center">Keep multiple browsers & devices in sync when building websites.</p>
22+
23+
<p align="center">Browsersync is developed and maintained internally at <a href="http://www.wearejh.com">JH</a></p>
24+
<p align="center">Follow <a href="https://twitter.com/browsersync">@Browsersync</a> on twitter for news & updates.</p>
25+
<p align="center">Community <a href="https://browsersync.herokuapp.com"><img src="https://browsersync.herokuapp.com/badge.svg" /></a></p>
26+
27+
## Features
28+
29+
Please visit [browsersync.io](https://browsersync.io) for a full run-down of features
30+
31+
## Requirements
32+
33+
Browsersync works by injecting an asynchronous script tag (`<script async>...</script>`) right after the `<body>` tag
34+
during initial request. In order for this to work properly the `<body>` tag must be present. Alternatively you
35+
can provide a custom rule for the snippet using [snippetOptions](https://www.browsersync.io/docs/options/#option-snippetOptions)
36+
37+
## Upgrading from 1.x to 2.x ?
38+
Providing you haven't accessed any internal properties, everything will just work as
39+
there are no breaking changes to the public API. Internally however, we now use an
40+
immutable data structure for storing/retrieving options. So whereas before you could access urls like this...
41+
42+
```js
43+
browserSync({server: true}, function(err, bs) {
44+
console.log(bs.options.urls.local);
45+
});
46+
```
47+
48+
... you now access them in the following way:
49+
50+
```js
51+
browserSync({server: true}, function(err, bs) {
52+
console.log(bs.options.getIn(["urls", "local"]));
53+
});
54+
```
55+
56+
## Install and trouble shooting
57+
58+
[browsersync.io docs](https://browsersync.io)
59+
60+
## Integrations / recipes
61+
62+
[Browsersync recipes](https://github.com/Browsersync/recipes)
63+
64+
## Support
65+
66+
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!
67+
68+
[![Support via PayPal](https://rawgithub.com/chris---/Donation-Badges/master/paypal.jpeg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=shakyshane%40gmail%2ecom&lc=US&item_name=browser%2dsync)
69+
70+
71+
Apache 2
72+
Copyright (c) 2019 Shane Osbourne

0 commit comments

Comments
 (0)