diff --git a/README.md b/README.md index b494452fe9..3047746417 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,15 @@ -

- -

+# Primer CSS +The CSS implementation of GitHub's Primer Design System -

Primer CSS

+[![npm package](https://img.shields.io/npm/v/@primer/css.svg)](https://www.npmjs.com/package/@primer/css) +[![build status](https://github.com/primer/css/actions/workflows/ci.yml/badge.svg)](https://github.com/primer/css/actions/workflows/ci.yml) +[![contributors graph](https://img.shields.io/github/contributors/primer/css.svg)](https://github.com/primer/css/graphs/contributors) +[![last commit](https://img.shields.io/github/last-commit/primer/css.svg)](https://github.com/primer/css/commits/main) +[![license](https://img.shields.io/github/license/primer/css.svg)](https://github.com/primer/css/blob/main/LICENSE) -

The CSS implementation of GitHub's Primer Design System

- -

- - - - - - - - - - - - - - - -

+> :warning: **This project is in KTLO mode!** Please use [primer/react](https://github.com/primer/react) and [primer/view_components](https://github.com/primer/view_components) for styling and markup instead. ## Documentation - -> :warning: It is encouraged that you use [primer/react](https://github.com/primer/react) and [primer/view_components](https://github.com/primer/view_components) for styling and markup. - -> :warning: **The documentation of this repo is not maintained anymore**. Please raise any documentation-specific pull requests in [primer.style/design](https://github.com/primer/design/) - Our documentation site lives at [primer.style/css](https://primer.style/css). You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more. ## Install @@ -40,7 +20,7 @@ npm install --save @primer/css ``` ## Usage -The included source files are written in [Sass] using SCSS syntax. After [installing](#install) with npm, you can add your project's `node_modules` directory to your Sass [include paths](https://github.com/sass/node-sass#includepaths) (AKA [load paths](http://technology.customink.com/blog/2014/10/09/understanding-and-using-sass-load-paths/) in Ruby), then import it like this: +The included source files are written in [Sass] using SCSS syntax. Once installed, you can add your project's `node_modules` directory to your Sass [include paths](https://github.com/sass/node-sass#includepaths) (AKA [load paths](http://technology.customink.com/blog/2014/10/09/understanding-and-using-sass-load-paths/) in Ruby), then import it like this: ```scss @import "@primer/css/index.scss"; @@ -67,5 +47,4 @@ You can find docs about our release process in [RELEASING.md](RELEASING.md). [install-npm]: https://docs.npmjs.com/getting-started/installing-node [npm]: https://www.npmjs.com/ -[primer]: https://primer.style/ [sass]: http://sass-lang.com/