Merge pull request #1380 from JulienMelissas/bs-docs

Added more explicit instructions for BrowserSync.
This commit is contained in:
Ben Word
2015-03-12 15:21:01 -05:00
2 changed files with 20 additions and 1 deletions

View File

@@ -83,8 +83,27 @@ You now have all the necessary dependencies to run the build process.
* `gulp watch` — Compile assets when file changes are made
* `gulp --production` — Compile assets for production (no source maps).
### Using BrowserSync
To use BrowserSync during `gulp watch` you need update `devUrl` at the bottom of `assets/manifest.json` to reflect your local development hostname.
For example, if your local development URL is `http://project-name.dev` you would update the file to read:
```json
...
"config": {
"devUrl": "http://project-name.dev"
}
...
```
If your local develoment URL looks like `http://localhost:8888/project-name/` you would update the file to read:
```json
...
"config": {
"devUrl": "http://localhost:8888/project-name/"
}
...
```
## Documentation
Sage documentation is available at [https://roots.io/sage/docs/](https://roots.io/sage/docs/).

View File

@@ -25,6 +25,6 @@
}
},
"config": {
"devUrl": "example.dev"
"devUrl": "http://example.dev"
}
}