Skip to content

Commit aec7c50

Browse files
committed
feat(README): Update for brevity and consistency
1 parent 106327d commit aec7c50

File tree

1 file changed

+18
-48
lines changed

1 file changed

+18
-48
lines changed

packages/core/README.md

Lines changed: 18 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,16 @@
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/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)
3+
[![Build Status](https://travis-ci.org/pattern-lab/patternlab-node.svg?branch=master)](https://travis-ci.org/pattern-lab/patternlab-node)
4+
![current release](https://img.shields.io/npm/v/@pattern-lab/core.svg)
5+
![license](https://img.shields.io/github/license/pattern-lab/patternlab-node.svg)
6+
[![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)
7+
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
48
[![node (scoped)](https://img.shields.io/node/v/@pattern-lab/patternlab-node.svg)]()
59
[![Join the chat at Gitter](https://badges.gitter.im/pattern-lab/node.svg)](https://gitter.im/pattern-lab/node)
610

711
# Pattern Lab Node Core
812

9-
This repository contains the core functionality for Pattern Lab Node. Pattern Lab helps you and your team build thoughtful, pattern-driven user interfaces using atomic design principles.
10-
11-
[Online Demo of Pattern Lab Output](http://demo.patternlab.io/)
12-
13-
## Support for Pattern Lab Node
14-
15-
Pattern Lab Node wouldn't be what it is today without the support of the community. It will always be free and open source. Continued development is made possible in part from the support of [these wonderful project supporters](https://github.com/pattern-lab/patternlab-node/wiki/Thanks). If you want to learn more about supporting the project, visit the [Pattern Lab Node Patreon page](https://www.patreon.com/patternlab).
16-
17-
**:100: Thanks for support from the following:**
18-
19-
* **[Brad Frost](http://bradfrost.com/)**
20-
* [Marcos Peebles](https://twitter.com/marcospeebles)
21-
* [Susan Simkins](https://twitter.com/susanmsimkins)
22-
* [Wilfred Nas](https://twitter.com/wnas)
13+
This repository contains the core functionality for Pattern Lab Node.
2314

2415
## Installation
2516

@@ -29,19 +20,18 @@ Pattern Lab Node can be used different ways. Editions are **example** pairings o
2920

3021
As of Pattern Lab Node 3.X, `patternlab-node` can run standalone, without the need for task runners like gulp or grunt.
3122

32-
`npm install @pattern-lab/patternlab-node`
23+
`npm install @pattern-lab/core`
3324

3425
See [Usage](#usage) for more information.
3526

3627
### Editions
3728

3829
For users wanting a more pre-packaged experience several editions are available.
3930

40-
* [Pattern Lab/Node: Gulp Edition](https://github.com/pattern-lab/edition-node-gulp) contains info how to get started within a Gulp task running environment.
41-
* [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.
42-
* [Pattern Lab/Node: Vanilla Edition](https://github.com/pattern-lab/edition-node) contains info how to get started within a pure node environment.
43-
* [Pattern Lab/Node: Webpack Edition](https://github.com/Comcast/patternlab-edition-node-webpack) contains info how to get started within a webpack environment.
44-
> Thanks to the team at Comcast for open-sourcing this stellar work!
31+
* [Pattern Lab/Node: Vanilla Edition](https://github.com/pattern-lab/patternlab-node/packages/edition-node) contains info how to get started within a pure node environment.
32+
33+
* [Pattern Lab/Node: Gulp Edition](https://github.com/pattern-lab/patternlab-node/packages/edition-node-gulp) contains info how to get started within a Gulp task running environment.
34+
4535

4636
## Ecosystem
4737

@@ -51,11 +41,11 @@ Core, and Editions, are part of the [Pattern Lab Ecosystem](http://patternlab.io
5141

5242
## Usage
5343

54-
`patternlab-node` can be required within any Node environment, taking in a configuration file at instantiation.
44+
`@pattern-lab/core` can be required within any Node environment, taking in a configuration file at instantiation.
5545

5646
```javascript
5747
const config = require('./patternlab-config.json');
58-
const patternlab = require('patternlab-node')(config);
48+
const patternlab = require('@pattern-lab/core')(config);
5949

6050
// build, optionally watching or choosing incremental builds
6151
patternlab.build({
@@ -73,7 +63,7 @@ patternlab.serve({
7363

7464
* Read more about the rest of [Public API](./docs), and already implemented for you within [Editions](#editions).
7565

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

7868
### Events
7969

@@ -97,38 +87,18 @@ patternlab.events.on('patternlab-global-change', (data) => {
9787

9888
## Development Installation / Workflow
9989

100-
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).
101-
102-
```bash
103-
mkdir /patternlab-node
104-
cd /patternlab-node
105-
git clone https://github.com/pattern-lab/patternlab-node.git
106-
npm install
107-
npm link
108-
cd location/of/editionOrSourceAndConfig
109-
npm link @pattern-lab/patternlab-node
110-
```
111-
112-
The above is a bit verbose, but illustrates:
113-
114-
1. how to clone this repository to an arbitrary location
115-
2. install all dependencies (run `npm install --dev` if your NODE_ENV is production for some reason)
116-
3. setup the `npm link` to your local copy
117-
4. use the local copy of patternlab-node in your edition / working directory
118-
119-
> Make sure to change to whichever branch you intend to hack on or test within your cloned repository, such as `dev` or `bugfix/fixes-broken-unittest`
120-
90+
If you are interested in contributing to Pattern Lab, please do take some time to learn how we [develop locally](https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md#developing-locally) within the contribution guidelines.
12191
## Upgrading
12292

12393
If you find yourself here and are looking to upgrade, check out how to upgrade from version to version of Pattern Lab Node here: [https://github.com/pattern-lab/patternlab-node/wiki/Upgrading](https://github.com/pattern-lab/patternlab-node/wiki/Upgrading)
12494

125-
View the [ChangeLog](https://github.com/pattern-lab/patternlab-node/wiki/ChangeLog) for the latest Pattern Lab Node updates.
95+
View the [latest releases](https://github.com/pattern-lab/patternlab-node/releases) for comprehensive changelogs.
12696

12797
## Contributing
12898

12999
If you'd like to contribute to Pattern Lab Node, please do so! There is always a lot of ground to cover and something for your wheelhouse.
130100

131-
Please read the guidelines: https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md
101+
Please read the [contribution guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md).
132102

133103
## Core Team
134104

0 commit comments

Comments
 (0)