Update README and Boilerplate occurrences

Changed "Configuration" section to instruct developers on what occurrences to rename throughout the package.
This commit is contained in:
Chauncey McAskill
2021-09-18 01:14:34 -04:00
parent 7e30939b14
commit 7e8a21f698
6 changed files with 26 additions and 9 deletions

View File

@@ -31,7 +31,24 @@ npm start
## Configuration
Rename occurrences of `locomotive-boilerplate` with your project's name in `loconfig.json`.
There are a few occurrences that should be renamed for your project:
* [package.json](package.json):
* Package name: `@locomotivemtl/boilerplate`
* Package title: `Locomotive Boilerplate`
* [package-lock.json](package-lock.json):
* Package name: `@locomotivemtl/boilerplate`
* [loconfig.json](loconfig.json):
* Browser Sync proxy URL: `locomotive-boilerplate.test`
Remove `paths.url` to use Browser Sync's built-in server which uses `paths.dest`.
* View path: `./views/boilerplate/template`
* [environment.js](assets/scripts/utils/environment.js):
* Application name: `Boilerplate`
* [site.webmanifest](www/site.webmanifest):
* Manifest name: `Locomotive Boilerplate`
* Manifest short name: `Boilerplate`
* HTML files:
* Page title: `Locomotive Boilerplate`
## Build