Skip to content

Commit 1847ef7

Browse files
authored
Merge pull request #42 from primer/brocs/update_readme
update readme
2 parents 2caacf3 + 55a1978 commit 1847ef7

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,23 @@
88

99
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.
1010

11-
## Getting started
11+
## Installation
1212

13-
`npm install`
13+
Install primer-react in your project with:
1414

15-
Run app with:
15+
`npm install primer-react`
1616

17-
`npm run start`
17+
## Local Development
1818

19-
Build with:
19+
Run `primer-react` locally when adding or updating components.
2020

21-
`npm run build`
21+
Clone this repo: `$ git clone https://github.com/primer/primer-react.git`
22+
23+
Install dependencies: `npm install`
24+
25+
Run app with: `npm run start`
26+
27+
Build docs before publishing: `npm run build`
2228

2329

2430
## Principles

0 commit comments

Comments
 (0)