Skip to content
This repository has been archived by the owner on Feb 7, 2023. It is now read-only.

Commit

Permalink
Merge pull request #14 from pattern-lab/dev
Browse files Browse the repository at this point in the history
Edition Node Grunt 1.1.0
  • Loading branch information
bmuenzenmeyer authored Aug 16, 2016
2 parents e0456cd + 43fbf65 commit e701350
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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"
Expand Down
7 changes: 6 additions & 1 deletion patternlab-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,10 @@
"patternExportDirectory": "./pattern_exports/",
"baseurl" : "",
"cacheBust": true,
"starterkitSubDir": "dist"
"starterkitSubDir": "dist",
"outputFileSuffixes": {
"rendered": "",
"rawTemplate": "",
"markupOnly": ".markup-only"
}
}

0 comments on commit e701350

Please sign in to comment.