Skip to content

Commit

Permalink
Tweak readme's. Add simpler npm scripts to avoid npm install -g (pala…
Browse files Browse the repository at this point in the history
…ntir#81)

* Tweak readme's. Add simpler npm scripts to avoid npm install -g

* PR Comments

* One more pluralization
  • Loading branch information
themadcreator authored Nov 11, 2016
1 parent 9292af9 commit 7d2c2f3
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 12 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,28 @@ This repository does not contain compiled assets so please install relevant pack

## Packages

This repository contains multiple projects in the `packages/` directory that are ultimately distributed as separate packages on NPM:
This repository contains multiple projects in the `packages/` directory that are distributed as separate packages on NPM:

[![npm](https://img.shields.io/npm/v/@blueprintjs/core.svg?label=@blueprintjs/core)](https://www.npmjs.com/package/@blueprintjs/core) – Core styles & components for the UI kit.

[![npm](https://img.shields.io/npm/v/@blueprintjs/datetime.svg?label=@blueprintjs/datetime)](https://www.npmjs.com/package/@blueprintjs/datetime) – Date & time UI components.

[![npm](https://img.shields.io/npm/v/@blueprintjs/table.svg?label=@blueprintjs/table)](https://www.npmjs.com/package/@blueprintjs/table) – Scalable interactive table UI components.
[![npm](https://img.shields.io/npm/v/@blueprintjs/table.svg?label=@blueprintjs/table)](https://www.npmjs.com/package/@blueprintjs/table) – Scalable interactive table UI component.

The other packages (`docs` and `landing`) are not published to NPM as they are used to build the documentation site.

## Development

We use [Lerna](https://github.com/lerna/lerna) to manage inter-package dependencies in this monorepo.
We use [Lerna](https://lernajs.io/) to manage inter-package dependencies in this monorepo.
Builds are orchestrated via [Gulp](http://gulpjs.com/) tasks.

__Prerequisite__: Node.js v6 or v7

1. `git clone` this repository (or fork if you lack permissions)
1. `npm install` to install build dependencies
1. `$(npm bin)/lerna bootstrap` to configure each package
1. `gulp` to compile and start the server
1. Visit [localhost:9000/packages/docs/dist/](http://localhost:9000/packages/docs/dist/)
1. `npm run bootstrap` to install and link each package using [lerna](https://lernajs.io/)
1. `npm run gulp` to compile and start the server and watcher
1. Open your browser to [localhost:9000/packages/docs/dist/](http://localhost:9000/packages/docs/dist/)

## Contributing

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"copy:docs": "cp -rf packages/docs/dist docs/docs",
"copy:landing": "cp -rf packages/landing/dist/* docs/.",
"delete:doc-source-maps" : "find docs -name '*.map' -type f -delete",
"gulp": "gulp",
"serve": "http-server docs"
},
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Blueprint is a React UI toolkit for the Web.

This package contains the core set of UI components as CSS and React code.

## Usage
## Installation

```
npm install --save @blueprintjs/core
Expand Down
2 changes: 1 addition & 1 deletion packages/datetime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Two third-party libraries are used in this package to ease the burden of time ma
- [react-day-picker](http://react-day-picker.js.org/) is a solid React calendaring library.
We use it internally for the calendar and expose some parts of its API (particularly modifiers).

## Usage
## Installation

```
npm install --save @blueprintjs/datetime
Expand Down
12 changes: 12 additions & 0 deletions packages/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# [Blueprint Documentation](http://blueprintjs.com/docs)

This project generates and aggregates the documentation from the packages
in this repo.

## Quick start

From the root of the repo:

1. Run `npm run bootstrap`
1. Run `npm run gulp`
1. Open your browser to http://localhost:9000
5 changes: 3 additions & 2 deletions packages/landing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ This is the landing page for http://blueprintjs.com.

## Quick start

1. `npm install`
1. `npm start`
1. From the root of the repo, run `npm run bootstrap`
1. Then, in this package directory, run `npm start`
1. Open your browser to http://localhost:8080
4 changes: 2 additions & 2 deletions packages/table/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Blueprint](http://blueprintjs.com/) Table Components
# [Blueprint](http://blueprintjs.com/) Table Component

Blueprint is a React UI toolkit for the Web.

Expand All @@ -15,7 +15,7 @@ or spreadsheet.
- Right-click to copy cell region contents
- Inline editable column headers & cells

## Usage
## Installation

```
npm install --save @blueprintjs/table
Expand Down

0 comments on commit 7d2c2f3

Please sign in to comment.