Skip to content

update readme #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 30, 2018
Merged

update readme #42

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b599e8
update readme
broccolini May 25, 2018
55a1978
tidy up sentence
broccolini May 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 adding or updating components.

`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
Expand Down