Visitar URL original
fix readme's · BrowserSync/browser-sync@6a587ec · GitHub
Skip to content

Commit 6a587ec

Browse files
shakyShaneshakyShane
committed
fix readme's
1 parent 91258ae commit 6a587ec

2 files changed

Lines changed: 72 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
<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">
2+
<a href="https://travis-ci.org/BrowserSync/browser-sync" title="Travis branch">
53
<img src="https://img.shields.io/travis/BrowserSync/browser-sync/master.svg?style=flat-square&label=linux" />
64
</a><a href="https://www.npmjs.com/package/browser-sync">
75
<img src="https://img.shields.io/npm/dm/browser-sync.svg?style=flat-square" />
@@ -10,18 +8,12 @@
108
<p align="center">
119
<a href="https://www.npmjs.com/package/browser-sync" title="NPM version">
1210
<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" />
1811
</a>
1912
</p>
2013
<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>
2114
<p align="center">Keep multiple browsers & devices in sync when building websites.</p>
2215

2316
<p align="center">Follow <a href="https://twitter.com/browsersync">@Browsersync</a> on twitter for news & updates.</p>
24-
<p align="center">Community <a href="https://browsersync.herokuapp.com"><img src="https://browsersync.herokuapp.com/badge.svg" /></a></p>
2517

2618
## Features
2719

@@ -35,20 +27,20 @@ can provide a custom rule for the snippet using [snippetOptions](https://www.bro
3527

3628
## Upgrading from 1.x to 2.x ?
3729
Providing you haven't accessed any internal properties, everything will just work as
38-
there are no breaking changes to the public API. Internally however, we now use an
39-
immutable data structure for storing/retrieving options. So whereas before you could access urls like this...
30+
there are no breaking changes to the public API. Internally however, we now use an
31+
immutable data structure for storing/retrieving options. So whereas before you could access urls like this...
4032

4133
```js
4234
browserSync({server: true}, function(err, bs) {
43-
console.log(bs.options.urls.local);
35+
console.log(bs.options.urls.local);
4436
});
4537
```
4638

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

4941
```js
5042
browserSync({server: true}, function(err, bs) {
51-
console.log(bs.options.getIn(["urls", "local"]));
43+
console.log(bs.options.getIn(["urls", "local"]));
5244
});
5345
```
5446

‎packages/browser-sync/readme.md‎

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

0 commit comments

Comments
 (0)