From 8b599e85095e596fe48f4b5183f6fcb8a0260bde Mon Sep 17 00:00:00 2001 From: Diana Mounter Date: Fri, 25 May 2018 18:32:30 -0400 Subject: [PATCH 1/2] update readme --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6e9beaab093..be9d28fc59d 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,23 @@ Currently we link to the latest built Primer CSS so that we may use current Primer styles to start to build components. This does not include `primer-base` so as to avoid unwanted base overrides. -## Getting started +## Installation -`npm install` +Install primer-react in your project with: -Run app with: +`npm install primer-react` -`npm run start` +## Local Development -Build with: +Run `primer-react` locally when working on adding or updating components with. -`npm run build` +Clone this repo: `$ git clone https://github.com/primer/primer-react.git` + +Install dependencies: `npm install` + +Run app with: `npm run start` + +Build docs before publishing: `npm run build` ## Principles From 55a19782f3c1018c7b357e0660cb7e876582eedc Mon Sep 17 00:00:00 2001 From: Diana Mounter Date: Wed, 30 May 2018 14:46:27 -0400 Subject: [PATCH 2/2] tidy up sentence --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index be9d28fc59d..815ef0b269b 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Install primer-react in your project with: ## Local Development -Run `primer-react` locally when working on adding or updating components with. +Run `primer-react` locally when adding or updating components. Clone this repo: `$ git clone https://github.com/primer/primer-react.git`