Skip to content
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.

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

Already on GitHub? Sign in to your account

README updates #350

Merged
merged 15 commits into from
Nov 16, 2018
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
![](https://user-images.githubusercontent.com/8960591/48100248-482e1d00-e1d7-11e8-81c1-303b4234dab0.jpg)

# Primer Components

[Primer](https://primer.github.io/) React components
React components for the Primer Design System

![npm](https://img.shields.io/npm/v/@primer/components.svg)
![GitHub contributors](https://img.shields.io/github/contributors/primer/components.svg)
![GitHub last commit](https://img.shields.io/github/last-commit/primer/components.svg)
![GitHub](https://img.shields.io/github/license/primer/components.svg)
[![Join us in Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/primer)



## Status

**鈿狅笍 This project is WIP and not ready for production use yet!**
emplums marked this conversation as resolved.
Show resolved Hide resolved

Currently we link to the latest build of [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.
shawnbot marked this conversation as resolved.
Show resolved Hide resolved
## Documentation

Our documentation site lives at [primer.style/components](https://primer.style/components). You'll be able to find the information listed in this README as well as detailed docs for each component, our theme, and system props.

## Installation

Expand All @@ -18,8 +30,6 @@ npm install @primer/components

## Usage

**If you are upgrading from a version before `1.0.0-beta`, please read the [migration docs](migrating.md).**
shawnbot marked this conversation as resolved.
Show resolved Hide resolved

All of our components are exported by name from `@primer/components`, so you can import them with:

```js
Expand All @@ -31,9 +41,7 @@ import {
} from '@primer/components'
```

### Styling

This project uses [emotion] to generate static CSS for most component styles, but still relies on [Primer CSS] for some classname-based styles that haven't yet been ported over. Components that haven't yet been ported over rely on [a subset of Primer CSS](https://github.com/primer/components/blob/master/src/primer-components.scss) that's globally injected at import time.
shawnbot marked this conversation as resolved.
Show resolved Hide resolved
Primer Components come with all necessary CSS built-in, so you don't need to worry about including [Primer CSS].
emplums marked this conversation as resolved.
Show resolved Hide resolved

#### Base styles

Expand Down