Skip to content

Commit 1f62617

Browse files
committed
fix(README): Update npm shield to point to scoped package
Closes #760
1 parent c726e60 commit 1f62617

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
![Pattern Lab Logo](/patternlab.png "Pattern Lab Logo")
1+
![Pattern Lab Logo](/patternlab.png 'Pattern Lab Logo')
22

3-
[![Build Status](https://travis-ci.org/pattern-lab/patternlab-node.svg?branch=master)](https://travis-ci.org/pattern-lab/patternlab-node) ![current release](https://img.shields.io/github/release/pattern-lab/patternlab-node.svg) ![license](https://img.shields.io/github/license/pattern-lab/patternlab-node.svg) [![Coverage Status](https://coveralls.io/repos/github/pattern-lab/patternlab-node/badge.svg?branch=master)](https://coveralls.io/github/pattern-lab/patternlab-node?branch=master) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
4-
[![Join the chat at Gitter](https://badges.gitter.im/pattern-lab/node.svg)](https://gitter.im/pattern-lab/node)
3+
[![Build Status](https://travis-ci.org/pattern-lab/patternlab-node.svg?branch=master)](https://travis-ci.org/pattern-lab/patternlab-node) ![current release](https://img.shields.io/npm/v/@pattern-lab/patternlab-node.svg) ![license](https://img.shields.io/github/license/pattern-lab/patternlab-node.svg) [![Coverage Status](https://coveralls.io/repos/github/pattern-lab/patternlab-node/badge.svg?branch=master)](https://coveralls.io/github/pattern-lab/patternlab-node?branch=master) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
4+
[![Join the chat at Gitter](https://badges.gitter.im/pattern-lab/node.svg)](https://gitter.im/pattern-lab/node)
55

66
# Pattern Lab Node Core
77

@@ -40,7 +40,7 @@ For users wanting a more pre-packaged experience several editions are available.
4040
* [Pattern Lab/Node: Grunt Edition](https://github.com/pattern-lab/edition-node-grunt) contains info how to get started within a Grunt task running environment.
4141
* [Pattern Lab/Node: Vanilla Edition](https://github.com/pattern-lab/edition-node) contains info how to get started within a pure node environment.
4242
* [Pattern Lab/Node: Webpack Edition](https://github.com/Comcast/patternlab-edition-node-webpack) contains info how to get started within a webpack environment.
43-
>Thanks to the team at Comcast for open-sourcing this stellar work!
43+
> Thanks to the team at Comcast for open-sourcing this stellar work!
4444
4545
## Ecosystem
4646

@@ -52,22 +52,20 @@ Core, and Editions, are part of the [Pattern Lab Ecosystem](http://patternlab.io
5252

5353
`patternlab-node` can be required within any Node environment, taking in a configuration file at instantiation.
5454

55-
``` javascript
56-
55+
```javascript
5756
const config = require('./patternlab-config.json');
5857
const patternlab = require('patternlab-node')(config);
5958

6059
// build, optionally watching or choosing incremental builds
6160
patternlab.build({
6261
cleanPublic: true,
63-
watch: true
62+
watch: true,
6463
});
6564

6665
// or build, watch, and then self-host
6766
patternlab.serve({
68-
cleanPublic: true
67+
cleanPublic: true,
6968
});
70-
7169
```
7270

7371
* Read more about [configuration](http://patternlab.io/docs/advanced-config-options.html#node) via `patternlab-config.json`.
@@ -76,13 +74,11 @@ patternlab.serve({
7674

7775
* A full-featured [command line interface](https://github.com/pattern-lab/patternlab-node-cli) is also available courtesy of [@raphaelokon](https://github.com/raphaelokon).
7876

79-
8077
### Events
8178

8279
Many [events](https://github.com/pattern-lab/patternlab-node/wiki/Creating-Plugins#events) are emitted during Pattern Lab operations, originally built to support plugins. Below is a sample, allowing users to be informed of asset or pattern changes.
8380

84-
``` javascript
85-
81+
```javascript
8682
patternlab.serve(...);
8783

8884
patternlab.events.on('patternlab-asset-change', (data) => {
@@ -96,14 +92,13 @@ patternlab.events.on('patternlab-pattern-change', (data) => {
9692
patternlab.events.on('patternlab-global-change', (data) => {
9793
console.log(data); // {file: 'path/to/file.ext'}
9894
});
99-
10095
```
10196

10297
## Development Installation / Workflow
10398

10499
If you are interested in [contributing to Pattern Lab](https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md), it's suggested to install an Edition of your choice and then run a local copy of this repository via [`npm link`](https://docs.npmjs.com/cli/link).
105100

106-
``` bash
101+
```bash
107102
mkdir /patternlab-node
108103
cd /patternlab-node
109104
git clone https://github.com/pattern-lab/patternlab-node.git
@@ -134,7 +129,6 @@ If you'd like to contribute to Pattern Lab Node, please do so! There is always a
134129

135130
Please read the guidelines: https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md
136131

137-
138132
## Core Team
139133

140134
* [@bmuenzenmeyer](https://github.com/bmuenzenmeyer) - Lead Maintainer

0 commit comments

Comments
 (0)