From d3ba74206a86578431285f1c1de3daf841e59c7b Mon Sep 17 00:00:00 2001 From: Nathan Lenkowski Date: Wed, 20 Feb 2019 14:48:42 +0100 Subject: [PATCH] Update readme and changelog --- CHANGELOG.md | 13 ++++++++++--- README.md | 42 +++++++++++++++++++++--------------------- style.css | 2 +- 3 files changed, 32 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fe3700b..215d136 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +### 1.4.1 - 2019-02-20 + +- Update dependencies +- Upgrade Laravel Mix to 4.x release +- Enable Browsersync and source maps for development builds only +- Move layouts styles to components directory + ### 1.4.0 - 2018-10-27 - Switch build system from Gulp to Laravel Mix / Webpack @@ -7,7 +14,7 @@ - Remove Susy and replace with flexbox layout - Improve typography and vertical rhythm - Add cache busting for script and style assets -- Add continous integration testing +- Add continuous integration testing - Add dependency status monitoring - Add stylelint config - Update ESLint config @@ -18,7 +25,7 @@ - Switch from Bower to npm for frontend dependencies - Add asset configuration file for managing paths and dependencies - Add ES6 support with Babel to scripts build task -- Switch scripts linter from jshint to eslint +- Switch scripts linter from JSHint to ESLint - Add font and image optimization build tasks - Add source maps generation to styles and scripts build tasks - Remove dist directory from version control @@ -32,7 +39,7 @@ - Remove button component - Improve adherence to WordPress coding standards - Improve indentation and comments -- Upgrade vendor dependencies +- Update dependencies ### 1.2.2 - 2016-02-02 diff --git a/README.md b/README.md index 9450381..bd4293b 100755 --- a/README.md +++ b/README.md @@ -3,25 +3,25 @@ [![Dependency Status](https://david-dm.org/nlenkowski/blujay.svg)](https://david-dm.org/nlenkowski/blujay#info=dependencies) [![Build Status](https://travis-ci.org/nlenkowski/blujay.svg?branch=master)](https://travis-ci.org/nlenkowski/blujay) -A minimal starter theme for WordPress. Built with modern tooling and sensible defaults. +Blujay is a minimal WordPress starter theme built with modern tooling and sensible defaults. -- [Webpage](http://blujay.littlebiglab.com) -- [Demo](http://blujay.littlebiglab.com/demo) +- [Home](https://blujay.littlebiglab.com) +- [Demo](https://blujay.littlebiglab.com/demo) - [Download](https://github.com/nlenkowski/blujay/releases/latest) - [GitHub](https://github.com/nlenkowski/blujay) ## Features -- [Webpack](https://webpack.js.org/) for modern JavaScript development -- [Laravel Mix](https://laravel-mix.com/) for easy Webpack configuration +- [Webpack](https://webpack.js.org) for modern JavaScript development +- [Laravel Mix](https://laravel-mix.com) for easy Webpack configuration - [Browsersync](https://browsersync.io) for synchronized browser testing -- [npm](https://www.npmjs.com/) for package management -- [Sass](https://sass-lang.com) for stylesheets, with configurable defaults for colors, typography, etc. -- [Mixins](https://github.com/nlenkowski/blujay/blob/master/assets/styles/common/_helpers.scss) for quickly defining named breakpoints in your styles -- [Shortcodes](https://github.com/nlenkowski/blujay/blob/master/lib/shortcodes.php) for using flexbox columns in page and post content -- [ESLint](https://eslint.org/) and [stylelint](https://stylelint.io/) for linting scripts and styles -- [Easy setup](https://github.com/nlenkowski/blujay/blob/master/lib/setup.php) for registering assets, menus, image sizes, sidebars, etc. -- [Helper functions](https://github.com/nlenkowski/blujay/blob/master/lib/helpers.php) for cleaning up the header, moving scripts to the footer, etc. +- [npm](https://www.npmjs.com) for front-end package management +- [Sass](https://sass-lang.com) for stylesheets, with sensible defaults for colors, typography, etc. +- [Mixins](https://github.com/nlenkowski/blujay/blob/master/assets/styles/common/_helpers.scss) for easily defining and using named breakpoints +- [Shortcodes](https://github.com/nlenkowski/blujay/blob/master/lib/shortcodes.php) for adding flexbox columns to pages and posts +- [ESLint](https://eslint.org) and [stylelint](https://stylelint.io) for linting scripts and styles +- [Setup](https://github.com/nlenkowski/blujay/blob/master/lib/setup.php) functions for registering assets, menus, image sizes, sidebars, etc. +- [Helper](https://github.com/nlenkowski/blujay/blob/master/lib/helpers.php) functions for cleaning up the header, moving scripts to the footer, etc. ## Requirements @@ -29,7 +29,7 @@ A minimal starter theme for WordPress. Built with modern tooling and sensible de - [PHP](https://secure.php.net/) >= 7.1 - [Node](https://nodejs.org/) >= 6.14 -## Theme installation +## Theme Installation 1. Download the [latest release](https://github.com/nlenkowski/blujay/releases/latest/) and unzip it into your `/wp-content/themes` directory. @@ -37,25 +37,25 @@ A minimal starter theme for WordPress. Built with modern tooling and sensible de 3. Run `npm run prod` to compile and optimize assets for production. -## Theme development +## Theme Development -1. Edit `/lib/setup.php` to enable theme features and register assets, menus, image sizes, sidebars, etc. +1. Edit `/lib/setup.php` to enable and/or disable theme features and register assets, menus, image sizes, sidebars, etc. 2. Edit `/webpack.mix.js` and change the browserSync `proxy` to reflect your local development url. -### Build commands +### Build Commands Compiled assets are output to the `/dist` directory. -- `npm run watch` – Compile assets when changes are detected and start a Browsersync session +- `npm run dev` – Compiles assets and generates source maps for development -- `npm run dev` – Compile assets +- `npm run prod` – Compiles and optimizes assets for production -- `npm run prod` – Compile assets and optimize for production +- `npm run watch` – Starts a Browsersync session and compiles assets when changes are detected -### Package management +### Package Management -Example of how to add 3rd party packages into your theme: +Example of how to include npm packages in your theme: 1. Install package diff --git a/style.css b/style.css index 89bb548..1293ff9 100755 --- a/style.css +++ b/style.css @@ -2,7 +2,7 @@ Theme Name: Blujay Theme URI: http://blujay.littlebiglab.com Description: A modern starter theme for WordPress -Version: 1.3.0 +Version: 1.4.1 Author: Nathan Lenkowski Author URI: http://littlebiglab.com */