diff --git a/README.md b/README.md index e00dfc9..19e2e77 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # Tailwind Jekyll Starter A starter kit for using [Tailwind](https://tailwindcss.com) (v0.7.3) with [Jekyll](https://jekyllrb.com/) that includes: * A barebones Jekyll starter theme -* A Gulp file with a default task that does the following: +* A Gulpfile that does the following: * Builds Tailwind * Strips out unused CSS using [Purgecss](http://www.purgecss.com/) * Runs [Autoprefixer](https://github.com/postcss/autoprefixer) * Minifies your CSS + * Generate a CSS sourcemap * Builds Jekyll * Runs [Browsersync](https://www.browsersync.io/) for live reload @@ -23,7 +24,6 @@ I used this starter for my personal blog. See the code [here](https://github.com ## Requirements * [Bundler](http://bundler.io/) -* [gulp-cli](https://www.npmjs.com/package/gulp-cli) * [Jekyll](https://jekyllrb.com/) * [Node.js](https://nodejs.org/en/) * [npm](https://www.npmjs.com/) @@ -32,11 +32,11 @@ I used this starter for my personal blog. See the code [here](https://github.com ## Getting started * `bundle install` to install Ruby gems * `npm install` to install npm packages -* `npm run start` to run the local development server using BrowserSync +* `npm run start` to compile the site with development settings and run BrowserSync + +## Build your site * `npm run build:dev` to compile the site with development settings * `npm run build` to compile the site for production -Need your CSS in the ``? Check out the [internal style version](https://github.com/taylorbryant/tailwind-jekyll-internal) of this starter kit. - ## License [MIT](https://github.com/taylorbryant/tailwind-jekyll/blob/master/LICENSE.md)