diff --git a/README.md b/README.md index a6e7e5b6860..e69de29bb2d 100644 --- a/README.md +++ b/README.md @@ -1,53 +0,0 @@ -

- Primer logo -

- -

Primer React

- -

A React implementation of GitHub's Primer Design System

- -

- - npm package - - - contributors graph - - - last commit - - - license - -

- -## Documentation - -Our documentation site lives at [primer.style/react](https://primer.style/react). You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more. - -## Installation - -Install @primer/react in your project with your package manager of choice: - -```console -npm install @primer/react -``` - -```console -yarn add @primer/react -``` - -## Template - -The fastest way make a prototype or try Primer React without setting up a new project is by using our [react template](https://github.com/primer/react-template). - -## Contributing - -We love collaborating with folks inside and outside of GitHub and welcome contributions! - -> 👉 See [the contributing docs](contributor-docs/CONTRIBUTING.md) for more info on code style, testing, coverage, and troubleshooting. - -## New Component Proposals - -We welcome and encourage new component proposals from internal GitHub teams! Our best work comes from collaborating directly with the teams using Primer React Components in their projects. If you'd like to kick off a new component proposal, please submit an issue using the [component proposal issue template](https://github.com/primer/react/issues/new?template=new-component-proposal.md) and we will get in touch!