Skip to content
This repository was archived by the owner on Dec 10, 2019. It is now read-only.

Commit 666dd2c

Browse files
committed
readme updates
1 parent fee9146 commit 666dd2c

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,11 @@ The Gulp Edition comes with the following components:
1313

1414
## Prerequisites
1515

16-
Pattern Lab Node uses [Node](https://nodejs.org) and [npm](https://www.npmjs.com/) to manage project dependencies, and [gulp](http://gulpjs.com/) to run tasks and interface with core.
16+
The Pattern Lab Node - Gulp Edition uses [Node](https://nodejs.org) for core processing, [npm](https://www.npmjs.com/) to manage project dependencies, and [gulp.js](http://gulpjs.com/) to run tasks and interface with the core library. Node version 4 or higher suffices. You can follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website if you haven't done so already. Installation of Node will include npm.
1717

18-
Please follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website. This should include `npm`.
18+
It's also highly recommended that you [install gulp](hhttps://github.com/gulpjs/gulp/blob/4.0/docs/getting-started.md) globally.
1919

20-
It's also highly recommended that you [install gulp](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md) globally.
21-
22-
* Note: The Gulp Edition uses Gulp 4, which may require a new global install of the CLI tool Gulp uses. Follow the [gulp upgrade instructions](https://github.com/pattern-lab/edition-node-gulp/wiki/Updating-to-Gulp-4) if you already have gulp installed and need to upgrade.
20+
> Note: The Gulp Edition of Pattern Lab uses Gulp 4, which may require a new global install of the Gulp command line interface. Follow the [gulp upgrade instructions](https://github.com/pattern-lab/edition-node-gulp/wiki/Updating-to-Gulp-4) if you already have gulp installed and need to upgrade. Gulp 4 is in alpha, but brings many benefits to the table and is relatively stable.
2321
2422
## Installing
2523

@@ -30,19 +28,22 @@ There are two methods for downloading and installing the Gulp Edition:
3028

3129
### Download a pre-built package
3230

33-
The fastest way to get started with the Gulp 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 [Default Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-default/tree/dev) installed by default.
31+
The fastest way to get started with the Gulp 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 [Demo Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-demo) installed by default.
3432

3533
**Please note:** Pattern Lab Node uses [npm](https://www.npmjs.com/) to manage project dependencies. To upgrade the Gulp Edition or to install plug-ins you'll need to be familiar with npm.
3634

3735
### Use npm
3836

3937
`npm` is a dependency management and package system which can pull in all of the Gulp Edition's dependencies for you. To accomplish this:
4038

41-
* download or clone this repository to an install location.
39+
* download or `git clone` this repository to an install location.
4240

4341
* run the following
42+
43+
```
4444
cd install/location
4545
npm install
46+
```
4647
4748
Running `npm install` from a directory containing a `package.json` file will download all dependencies defined within.
4849

0 commit comments

Comments
 (0)