framework/sage
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add additional commands to readme, fix BrowserSync docs

Browse Source
This commit is contained in:
QWp6t
2016-09-09 10:11:36 -07:00
parent ab27b45d95
commit 572b074a9e
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -90,6 +90,12 @@ You now have all the necessary dependencies to run the build process.
* `npm run start` — Compile assets when file changes are made, start BrowserSync session * `npm run start` — Compile assets when file changes are made, start BrowserSync session
* `npm run build:production` — Compile assets for production * `npm run build:production` — Compile assets for production
#### Additional commands
* `npm run clean` — Remove your `dist/` folder
* `npm run lint` — Run eslint against your assets and build scripts
* `composer test` — Check your PHP for code smells with `phpmd` and PSR-2 compliance with `phpcs`
### Using BrowserSync ### Using BrowserSync
To use BrowserSync during `npm run start` you need to update `devUrl` at the bottom of `assets/config.json` to reflect your local development hostname. To use BrowserSync during `npm run start` you need to update `devUrl` at the bottom of `assets/config.json` to reflect your local development hostname.
@@ -105,10 +111,7 @@ If you are not using [Bedrock](https://roots.io/bedrock/), update `publicPath` t
```json ```json
... ...
"output": { "publicPath": "/wp-content/themes/sage/"
"path": "dist",
"publicPath": "/wp-content/themes/sage/dist/"
}
... ...
``` ```