Merge pull request #70 from bstaruk/develop

3.3.0
bstaruk · Aug 31, 2021 · 765df4a · 765df4a
2 parents e8217e1 + b8061a3
commit 765df4a
Show file tree

Hide file tree

Showing 21 changed files with 749 additions and 2,385 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,8 @@ starbase is a production-ready website boilerplate built with webpack 5, Babel 7
 
 The primary mission is to be small in scope so that it may be easily extended and customized, or used as a learning tool for developers who are trying to become familiar with webpack 5, Sass and/or modern JS.
 
+---
+
 ## Getting Started
 
 After completing the steps below, you will be ready to begin using starbase:
@@ -42,15 +44,17 @@ cd /path/to/starbase
 npm run build
 ```
 
+---
+
 ## Features & Configurations
 
-### JS & Sass linting
+### JS & Sass Linting
 
 starbase uses [ESLint](http://eslint.org/) for Javascript (ES6) linting and [stylelint](https://github.com/stylelint/stylelint) for Sass linting to encourage consistent code throughout your project. The configs (`/.eslintrc.js` and `/.stylelintrc.js` respectively) include a solid foundation to build upon, utilizing the most popular industry-standardized plugins such as [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb) and [stylelint-config-sass-guidelines](https://github.com/bjankord/stylelint-config-sass-guidelines).
 
 ### Prettier JS Formatting
 
-starbase uses [Prettier](https://github.com/prettier/prettier) to enforce and simplify code consistency. If you use VS Code, check out the [Prettier VS Code extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode).
+starbase uses [Prettier](https://github.com/prettier/prettier) to enforce and simplify code consistency. If you use VS Code, check out the [Prettier VS Code extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode). If you'd rather prettify your code via CLI, run `npm run prettify` at your project root.
 
 ### HTML Webpack Plugin
 
@@ -87,6 +91,8 @@ If you want to remove these for any reason, perform the following steps:
 1. remove `es6-promise` & `whatwg-fetch` from `/package.json`
 2. remove the relevant imports in `/src/app.js`
 
+---
+
 ## Notes & Considerations
 
 ### Root Path
@@ -95,6 +101,8 @@ starbase is setup to run with assets referenced via relative paths so generated
 
 This variable should be set to `/` if the app will run at the root of a domain or subdomain, or to `/folderName` (example) if it'll be deployed to a subfolder.
 
+---
+
 ## License
 
 starbase is open source and free software, so you may to do whatever you wish with it -- commercially or personally. You can buy me a beer next time you're in Boston, star the project and tell a friend, or you can erase all signs of origin and tell your coworkers that you made it yourself. It's all good!