Skip to content

Commit 0977ceb

Browse files
authored
update documention post-promotion (#17)
Fixes #16 Co-authored-by: tyler36 <[email protected]>
1 parent 79bafb0 commit 0977ceb

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

Diff for: README.md

+19-13
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# tyler36/ddev-browsersync <!-- omit in toc -->
1+
# ddev-browsersync <!-- omit in toc -->
22

3-
[![tests](https://github.com/tyler36/ddev-browsersync/actions/workflows/tests.yml/badge.svg)](https://github.com/tyler36/ddev-browsersync/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2022.svg)
3+
[![tests](https://github.com/drud/ddev-browsersync/actions/workflows/tests.yml/badge.svg)](https://github.com/drud/ddev-browsersync/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2022.svg)
44

55
- [Introduction](#introduction)
6-
- [Requirements](#requirements)
76
- [Getting Started](#getting-started)
8-
- [Laravel-mix example](#laravel-mix-example)
7+
- [What does this add-on do and add?](#what-does-this-add-on-do-and-add)
8+
- [Other ways to use browsersync with this add-on](#other-ways-to-use-browsersync-with-this-add-on)
9+
- [Basic usage](#basic-usage)
10+
- [Problems](#problems)
11+
- [Laravel-mix configuration](#laravel-mix-configuration)
912
- [TODO](#todo)
1013

1114
## Introduction
@@ -25,13 +28,13 @@ This add-on requires DDEV v1.19.3 or higher.
2528
- Install the DDEV browsersync add-on:
2629

2730
```shell
28-
ddev get tyler36/ddev-browsersync
31+
ddev get drud/ddev-browsersync
2932
ddev restart
3033
ddev browsersync
3134
```
3235

3336
The new `ddev browsersync` global command runs browsersync inside the web container and provides a
34-
link ("External") to the browsersync-update URL. Use the URL in the output that says something like "External: http://d9.ddev.site:3000".
37+
link ("External") to the browsersync-update URL. Use the URL in the output that says something like "External: <http://d9.ddev.site:3000>".
3538

3639
## What does this add-on do and add?
3740

@@ -42,6 +45,7 @@ link ("External") to the browsersync-update URL. Use the URL in the output that
4245
5. Adds a `ddev browsersync` shell command globally, which lets you easily start browsersync when you want it.
4346

4447
## Other ways to use browsersync with this add-on
48+
4549
There are many other options to integrate browsersync into your project, including:
4650

4751
- [Grunt](https://browsersync.io/docs/grunt)
@@ -59,16 +63,18 @@ should be watched. If you watch less things it's easier on your computer.
5963

6064
### Problems
6165

62-
* If you get `Error: ENOSPC: System limit for number of file watchers reached, watch '/var/www/html/web/core/themes/classy/images/icons/video-x-generic.png'` it means you either have to increase the file watcher limit or decrease the number of files you're watching.
63-
* To decrease the number of files you're watching, edit the `ignore` section in `browser-sync.js` (or another config file if you have a more complex setup).
64-
* On colima, `colima ssh` and `sudo sysctl fs.inotify.max_user_watches` to see how many watches you have. To increase it, use something like `sudo sysctl -w fs.inotify.max_user_watches=2048576`. Unfortunately, this has to be done on every colima restart.
65-
* On Docker Desktop for Mac, `docker run -it --privileged --pid=host justincormack/nsenter1` and `sysctl -w fs.inotify.max_user_watches=1048576`. Unfortunately, this has to be done again on every Docker restart.
66-
* On Docker Desktop for Windows, add or edit `~/.wslconfig` with these contents:
67-
```
66+
- If you get `Error: ENOSPC: System limit for number of file watchers reached, watch '/var/www/html/web/core/themes/classy/images/icons/video-x-generic.png'` it means you either have to increase the file watcher limit or decrease the number of files you're watching.
67+
- To decrease the number of files you're watching, edit the `ignore` section in `browser-sync.js` (or another config file if you have a more complex setup).
68+
- On colima, `colima ssh` and `sudo sysctl fs.inotify.max_user_watches` to see how many watches you have. To increase it, use something like `sudo sysctl -w fs.inotify.max_user_watches=2048576`. Unfortunately, this has to be done on every colima restart.
69+
- On Docker Desktop for Mac, `docker run -it --privileged --pid=host justincormack/nsenter1` and `sysctl -w fs.inotify.max_user_watches=1048576`. Unfortunately, this has to be done again on every Docker restart.
70+
- On Docker Desktop for Windows, add or edit `~/.wslconfig` with these contents:
71+
72+
```config
6873
[wsl2]
6974
kernelCommandLine = "fs.inotify.max_user_watches=1048576"
7075
```
71-
* On Linux, you can change `fs.inotify.max_user_watches` on the host in /etc/sysctl.d/local.conf or elsewhere.
76+
77+
- On Linux, you can change `fs.inotify.max_user_watches` on the host in /etc/sysctl.d/local.conf or elsewhere.
7278
7379
### Laravel-mix configuration
7480

0 commit comments

Comments
 (0)