From 7e8a21f69865bf67694b2b158a94753bf042eb0a Mon Sep 17 00:00:00 2001 From: Chauncey McAskill Date: Sat, 18 Sep 2021 01:14:34 -0400 Subject: [PATCH] Update README and Boilerplate occurrences Changed "Configuration" section to instruct developers on what occurrences to rename throughout the package. --- README.md | 19 ++++++++++++++++++- www/assets/emails/index.html | 2 +- www/form.html | 4 ++-- www/images.html | 4 ++-- www/index.html | 4 ++-- www/site.webmanifest | 2 +- 6 files changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f290c46..d3286b0 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/www/assets/emails/index.html b/www/assets/emails/index.html index 65af28a..6da105d 100644 --- a/www/assets/emails/index.html +++ b/www/assets/emails/index.html @@ -2,7 +2,7 @@ - Boilerplate + Email | Locomotive Boilerplate
diff --git a/www/form.html b/www/form.html index e22d0e0..f545751 100644 --- a/www/form.html +++ b/www/form.html @@ -2,7 +2,7 @@ - Form | Boilerplate + Form | Locomotive Boilerplate @@ -20,7 +20,7 @@
-

Boilerplate

 +

Locomotive Boilerplate