fix readme's

BrowserSync · Mar 15, 2022 · 6a587ec · 6a587ec
1 parent 91258ae
commit 6a587ec
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,5 @@
 <p align="center">
-<a href="https://ci.appveyor.com/project/shakyShane/browser-sync" title="AppVeyor branch">
- <img src="https://img.shields.io/appveyor/ci/shakyshane/browser-sync/master.svg?style=flat-square&label=windows" />
-</a><a href="https://travis-ci.org/BrowserSync/browser-sync" title="Travis branch">
+<a href="https://travis-ci.org/BrowserSync/browser-sync" title="Travis branch">
  <img src="https://img.shields.io/travis/BrowserSync/browser-sync/master.svg?style=flat-square&label=linux" />
 </a><a href="https://www.npmjs.com/package/browser-sync">
  <img src="https://img.shields.io/npm/dm/browser-sync.svg?style=flat-square" />
@@ -10,18 +8,12 @@
 <p align="center">
 <a href="https://www.npmjs.com/package/browser-sync" title="NPM version">
  <img src="https://img.shields.io/npm/v/browser-sync.svg?style=flat-square" />
-</a><a href="https://david-dm.org/Browsersync/browser-sync" title="Dependency Status">
- <img src="https://img.shields.io/david/Browsersync/browser-sync.svg?style=flat-square&label=deps" />
-</a>
-<a href="https://david-dm.org/Browsersync/browser-sync#info=devDependencies" title="devDependency Status">
- <img src="https://img.shields.io/david/dev/Browsersync/browser-sync.svg?style=flat-square&label=devDeps" />
 </a>
 </p>
 <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>
 <p align="center">Keep multiple browsers & devices in sync when building websites.</p>
 
 <p align="center">Follow <a href="https://twitter.com/browsersync">@Browsersync</a> on twitter for news & updates.</p>
-<p align="center">Community <a href="https://browsersync.herokuapp.com"><img src="https://browsersync.herokuapp.com/badge.svg" /></a></p>
 
 ## Features
 
@@ -35,20 +27,20 @@ can provide a custom rule for the snippet using [snippetOptions](https://www.bro
 
 ## 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...
+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...
 
 ```js
 browserSync({server: true}, function(err, bs) {
-    console.log(bs.options.urls.local);
+  console.log(bs.options.urls.local);
 });
 ```
 
 ... you now access them in the following way:
 
 ```js
 browserSync({server: true}, function(err, bs) {
-    console.log(bs.options.getIn(["urls", "local"]));
+  console.log(bs.options.getIn(["urls", "local"]));
 });
 ```
 

diff --git a/packages/browser-sync/readme.md b/packages/browser-sync/readme.md
@@ -1 +1,67 @@
-# browser-sync
+<p align="center">
+<a href="https://travis-ci.org/BrowserSync/browser-sync" title="Travis branch">
+ <img src="https://img.shields.io/travis/BrowserSync/browser-sync/master.svg?style=flat-square&label=linux" />
+</a><a href="https://www.npmjs.com/package/browser-sync">
+ <img src="https://img.shields.io/npm/dm/browser-sync.svg?style=flat-square" />
+</a>
+</p>
+<p align="center">
+<a href="https://www.npmjs.com/package/browser-sync" title="NPM version">
+ <img src="https://img.shields.io/npm/v/browser-sync.svg?style=flat-square" />
+</a>
+</p>
+<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>
+<p align="center">Keep multiple browsers & devices in sync when building websites.</p>
+
+<p align="center">Follow <a href="https://twitter.com/browsersync">@Browsersync</a> on twitter for news & updates.</p>
+
+## Features
+
+Please visit [browsersync.io](https://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](https://www.browsersync.io/docs/options/#option-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...
+
+```js
+browserSync({server: true}, function(err, bs) {
+    console.log(bs.options.urls.local);
+});
+```
+
+... you now access them in the following way:
+
+```js
+browserSync({server: true}, function(err, bs) {
+    console.log(bs.options.getIn(["urls", "local"]));
+});
+```
+
+## Install and trouble shooting
+
+[browsersync.io docs](https://browsersync.io)
+
+## Integrations / recipes
+
+[Browsersync recipes](https://github.com/Browsersync/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!
+
+[Support via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=shakyshane%40gmail%2ecom&lc=US&item_name=browser%2dsync)
+
+## Supported by
+
+Originally supported by [JH](https://www.wearejh.com) - they provided financial support as well as access to a professional designer to help with Branding.
+
+Apache 2
+Copyright (c) 2021 Shane Osbourne