From 2169131a75230a9517d20a476ebbb9b0730f2e20 Mon Sep 17 00:00:00 2001 From: Henry Date: Mon, 1 Aug 2016 22:22:13 -0400 Subject: [PATCH 1/5] readme typos --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d77fc29..cc26d79 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ There are two methods for downloading and installing the Grunt Edition: ### Download a pre-built package -The fastest way to get started with the Grunt Edition is to [download the pre-built version](https://github.com/pattern-lab/edition-node-gulp/releases) from the [releases page](https://github.com/pattern-lab/edition-node-gulp/releases). The pre-built project comes with the [Base Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-base) installed by default. +The fastest way to get started with the Grunt Edition is to [download the pre-built version](https://github.com/pattern-lab/edition-node-grunt/releases) from the [releases page](https://github.com/pattern-lab/edition-node-grunt/releases). The pre-built project comes with the [Base Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-base) installed by default. **Please note:** Pattern Lab Node uses [npm](https://www.npmjs.com/) to manage project dependencies. To upgrade the Grunt Edition or to install plug-ins you'll need to be familiar with npm. From 07bc42755b313e851d22081ab01a9394c1699012 Mon Sep 17 00:00:00 2001 From: BRIAN MUENZENMEYER Date: Sun, 14 Aug 2016 14:10:58 -0500 Subject: [PATCH 2/5] postinstall script as part of https://github.com/pattern-lab/patternlab-node/issues/362 --- package.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/package.json b/package.json index fc47fb6..2bedd34 100644 --- a/package.json +++ b/package.json @@ -27,6 +27,9 @@ }, "bugs": "https://github.com/pattern-lab/edition-node-grunt/issues", "author": "Brian Muenzenmeyer", + "scripts": { + "postinstall": "node node_modules/patternlab-node/core/scripts/postinstall.js" + }, "license": "MIT", "engines": { "node": ">=5.0" From 3d36ca63c227e881eefa44fb6c8b792c6f06d490 Mon Sep 17 00:00:00 2001 From: BRIAN MUENZENMEYER Date: Sun, 14 Aug 2016 14:16:49 -0500 Subject: [PATCH 3/5] bump version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 2bedd34..201acbe 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "edition-node-grunt", "description": "The grunt wrapper around patternlab-node core, providing tasks to interact with the core library and move supporting frontend assets.", - "version": "1.0.1", + "version": "1.1.0", "main": "./core/lib/patternlab.js", "dependencies": { "bs-html-injector": "^3.0.0", From 2b5ac7679fee39294e916928f4dbec9281bba401 Mon Sep 17 00:00:00 2001 From: BRIAN MUENZENMEYER Date: Mon, 15 Aug 2016 15:13:58 -0500 Subject: [PATCH 4/5] mirror default output suffixes as in https://github.com/pattern-lab/edition-node-gulp/pull/72/commits/7d6effc85f1cb3ccde234d50f38ca4ba3c3a957a --- patternlab-config.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/patternlab-config.json b/patternlab-config.json index 874803c..f0ca808 100644 --- a/patternlab-config.json +++ b/patternlab-config.json @@ -64,5 +64,10 @@ "patternExportDirectory": "./pattern_exports/", "baseurl" : "", "cacheBust": true, - "starterkitSubDir": "dist" + "starterkitSubDir": "dist", + "outputFileSuffixes": { + "rendered": "", + "rawTemplate": "", + "markupOnly": ".markup-only" + } } From 43fbf657ad173007ad29f90eb12c0d12a8b88e74 Mon Sep 17 00:00:00 2001 From: BRIAN MUENZENMEYER Date: Mon, 15 Aug 2016 20:58:58 -0500 Subject: [PATCH 5/5] Adding a getting started section --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index cc26d79..3a1e1d6 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,12 @@ Use npm's [`install` command](https://docs.npmjs.com/cli/install) with an argume This will install the Grunt Edition into a directory called `node_modules` in `install/location/`. +## Getting started + +The Pattern Lab Node - Grunt Edition ships with a [base experience](https://github.com/pattern-lab/starterkit-mustache-base) which serves as clean place to start from scratch with Pattern Lab. But if you want to get rolling with a starterkit of your own, or use the [demo starterkit](https://github.com/pattern-lab/starterkit-mustache-demo) like the one on [demo.patternlab.io](http://demo.patternlab.io), you can do so automatically at time of `npm install` by adding your starterkit to the `package.json` file. + +You can also [work with starterkits using the command line](https://github.com/pattern-lab/patternlab-node/wiki/Importing-Starterkits). + ## Updating Pattern Lab To update Pattern Lab please refer to each component's GitHub repository, and the [master instructions for core](https://github.com/pattern-lab/patternlab-node/wiki/Upgrading). The components are listed at the top of the README.