Skip to content

Commit 0eb0278

Browse files
Revise README for clarity and project status
Updated README to reflect project status and usage instructions.
1 parent 65e1bde commit 0eb0278

File tree

1 file changed

+9
-30
lines changed

1 file changed

+9
-30
lines changed

README.md

Lines changed: 9 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,15 @@
1-
<p align="center">
2-
<img width="300px" alt="" src="./docs/src/readme.png">
3-
</p>
1+
# Primer CSS
2+
The CSS implementation of GitHub's Primer Design System
43

5-
<h1 align="center">Primer CSS</h1>
4+
[![npm package](https://img.shields.io/npm/v/@primer/css.svg)](https://www.npmjs.com/package/@primer/css)
5+
[![build status](https://github.com/primer/css/actions/workflows/ci.yml/badge.svg)](https://github.com/primer/css/actions/workflows/ci.yml)
6+
[![contributors graph](https://img.shields.io/github/contributors/primer/css.svg)](https://github.com/primer/css/graphs/contributors)
7+
[![last commit](https://img.shields.io/github/last-commit/primer/css.svg)](https://github.com/primer/css/commits/main)
8+
[![license](https://img.shields.io/github/license/primer/css.svg)](https://github.com/primer/css/blob/main/LICENSE)
69

7-
<p align="center">The CSS implementation of GitHub's Primer Design System</p>
8-
9-
<p align="center">
10-
<a aria-label="npm package" href="https://www.npmjs.com/package/@primer/css">
11-
<img alt="" src="https://img.shields.io/npm/v/@primer/css.svg">
12-
</a>
13-
<a aria-label="build status" href="https://github.com/primer/css/actions/workflows/ci.yml">
14-
<img alt="" src="https://github.com/primer/css/actions/workflows/ci.yml/badge.svg">
15-
</a>
16-
<a aria-label="contributors graph" href="https://github.com/primer/css/graphs/contributors">
17-
<img alt="" src="https://img.shields.io/github/contributors/primer/css.svg">
18-
</a>
19-
<a aria-label="last commit" href="https://github.com/primer/css/commits/main">
20-
<img alt="" src="https://img.shields.io/github/last-commit/primer/css.svg">
21-
</a>
22-
<a aria-label="license" href="https://github.com/primer/css/blob/main/LICENSE">
23-
<img src="https://img.shields.io/github/license/primer/css.svg" alt="">
24-
</a>
25-
</p>
10+
> :warning: **This project is in KTLO mode!** Please you use [primer/react](https://github.com/primer/react) and [primer/view_components](https://github.com/primer/view_components) for styling and markup instead.
2611
2712
## Documentation
28-
29-
> :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.
30-
31-
> :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/)
32-
3313
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.
3414

3515
## Install
@@ -40,7 +20,7 @@ npm install --save @primer/css
4020
```
4121

4222
## Usage
43-
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:
23+
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:
4424

4525
```scss
4626
@import "@primer/css/index.scss";
@@ -67,5 +47,4 @@ You can find docs about our release process in [RELEASING.md](RELEASING.md).
6747

6848
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
6949
[npm]: https://www.npmjs.com/
70-
[primer]: https://primer.style/
7150
[sass]: http://sass-lang.com/

0 commit comments

Comments
 (0)