From 0eb0278d45f9d7e18f4c02424e3af8afd049b7f3 Mon Sep 17 00:00:00 2001
From: Lukas Oppermann
Date: Wed, 24 Sep 2025 08:44:07 +0200
Subject: [PATCH 1/2] Revise README for clarity and project status
Updated README to reflect project status and usage instructions.
---
README.md | 39 +++++++++------------------------------
1 file changed, 9 insertions(+), 30 deletions(-)
diff --git a/README.md b/README.md
index b494452fe9..937a533c41 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,15 @@
-
-
-
+# Primer CSS
+The CSS implementation of GitHub's Primer Design System
-Primer CSS
+[](https://www.npmjs.com/package/@primer/css)
+[](https://github.com/primer/css/actions/workflows/ci.yml)
+[](https://github.com/primer/css/graphs/contributors)
+[](https://github.com/primer/css/commits/main)
+[](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 you 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/
From 4d71890e990fbb3f367deebd87c1fda89df86751 Mon Sep 17 00:00:00 2001
From: Lukas Oppermann
Date: Wed, 24 Sep 2025 14:09:29 +0200
Subject: [PATCH 2/2] Update README.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 937a533c41..3047746417 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ The CSS implementation of GitHub's Primer Design System
[](https://github.com/primer/css/commits/main)
[](https://github.com/primer/css/blob/main/LICENSE)
-> :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.
+> :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
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.