documentaion

Gruntfile.js

@@ -104,13 +104,22 @@ module.exports = function(grunt) {
     ]);
 
     // register task
-    grunt.registerTask('mika', [
+    grunt.registerTask('build', [
         'terser',
         'sass',
         'cssmin',
         'postcss',
     ]);
 
+    // register task
+    grunt.registerTask('watch', [
+        'terser',
+        'sass',
+        'cssmin',
+        'postcss',
+        'watch',
+    ]);
+
     // register task
     grunt.registerTask('default', [
         'terser',

package.json

@@ -1,7 +1,7 @@
 {
   "name": "yikes-inc-starter-theme",
   "version": "1.0.0",
-  "description": "Yikes Inc. starter theme..",
+  "description": "Yikes Inc. starter theme.",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

readme.md

@@ -4,27 +4,65 @@ The 100% Original Theme for LezWatch.TV
 
 ## Description
 
-[ ![Codeship Status for LezWatch/lwtv-underscores](https://app.codeship.com/projects/23254790-5aa1-0135-27f4-1aaa9552a23d/status?branch=production)](https://lezwatchtv.com)
+Based on the [Yikes!](https://YikesInc.com) Starter Theme, the LezWatch.TV theme has been customized for custom post types (shows, characters, actors), and is fully integrated with the LezWatch.TV Plugin.
 
-Based on the Yikes Starter Theme, the LezWatch.TV theme has been customized for custom post types (shows, characters, actors), and is fully integrated with the LezWatch.TV Plugin.
+## Requirements
 
-## Features
+- PHP 8.1 or higher
+- [Grunt](https://gruntjs.com)
+- [Node.js](https://nodejs.org) version 16+
 
-* Supports three Custom Post Types and related taxonomies: Characters, Themes, Actors
-* Integrated with LWTV Plugin
-* Integrated with FacetWP
-* Additional custom image sizes: Show (960x400), Character (225x300), Actor (225x300)
-* Additional custom sidebars: Show, Character, and Actor Archives
-* Widgets: Display latest custom post type posts (show and character) with image
-* Customized search to limit to specific CPTs
+It's recommended to use [Homebrew](https://brew.sh) on macOS or [Chocolatey](https://chocolatey.org) for Windows to install the project dependencies.
+
+## Setup 🛠
+
+1. Clone this repository: `git clone git@github.com:lezwatch/lwtv-underscores`
+2. Move into the project directory: `cd lwtv-underscores`
+3. Install the project dependencies: `npm install`
+
+## Contributing
+
+All code must pass through the `development` branch which is kept up tp date. As such, any pull requests should be made to **development**, which will push the code automatically to our development server for testing.
+
+1. Using the `development` branch as base, create a new branch with a descriptive name like `fixing-charts` or `fix/chartjs421` or `feature/latest-posts` . Commit your work to that branch until it's ready for full testing
+2. Open [a pull request](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request) from your feature branch to the `development` branch.
+3. If you are not a main developer, your pull request will be reviewed before it can be merged. If there are issues or changes needed, you may be asked to do so, or they may be done for you.
+4. When the code passes review, it will be merged into the `development` branch and can be tested on the dev server.
+5. Once the code passes tests, the `development` branch will be merged into `production` and the job is done!
+
+To install and update:
+
+* `$ npm install` - Install all the things.
+* `$ npm update` - Updates all the things.
+* `$ grunt build` - Builds all the CSS.
 
-## Library Update
+Commits are currently not linted by default.
 
-To update shared libraries, run `composer update`
+### CSS
 
-## Deployment
+If you're updating CSS you have a couple options, since it's all SCSS:
 
-Pushes to branches are automatically deployed via Actions as follows:
+1. `grunt watch` - run grunt and leave open for ongoing changes.
+2. `grunt build` - run the build process once.
+
+### Libraries
+
+JS libraries are included via NPM.
+
+The `vendor` and `node_module` files are not synced to Github, to minimize the amount of files stored on the servers.
+
+### Deployment
+
+Pushes to branches are automatically deployed via Github Actions as follows:
 
 * Development: [lezwatchtvcom.stage.site](https://lezwatchtvcom.stage.site) (password required - Ask Mika)
 * Production: [lezwatchtv.com](https://lezwatchtv.com)
+
+## Features
+
+* Supports three Custom Post Types and related taxonomies: Characters, Themes, Actors
+* Integrated with LWTV Plugin
+* Integrated with [FacetWP](https://facetwp.com), [Jetpack Instant Search](https://jetpack.com/support/search/), and [CMB2](https://cmb2.io/).
+* Additional custom image sizes: Show (960x400), Character (225x300), Actor (225x300)
+* Additional custom sidebars: Show, Character, and Actor Archives
+* Widgets: Display latest custom post type posts (show and character) with image