diff --git a/README.md b/README.md index d320c1e0..906c7890 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,29 @@ -# Pigment CSS + +

Pigment CSS

Pigment CSS is a zero-runtime CSS-in-JS library that extracts the colocated styles to their own CSS files at build time. +
+ +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/pigment-css/blob/HEAD/LICENSE) +[![npm latest package](https://img.shields.io/npm/v/@pigment-css/react/latest.svg)](https://www.npmjs.com/package/@pigment-css/react) +[![npm downloads](https://img.shields.io/npm/dm/@pigment-css/react.svg)](https://www.npmjs.com/package/@pigment-css/react) +[![GitHub branch status](https://img.shields.io/github/checks-status/mui/pigment-css/HEAD)](https://app.codecov.io/gh/mui/pigment-css/tree/master) + + + +[![Coverage status](https://img.shields.io/codecov/c/github/mui/pigment-css/master.svg)](https://codecov.io/gh/mui/pigment-css/branch/master) +[![Follow on X](https://img.shields.io/twitter/follow/PigmentCSS.svg?label=follow+Pigment+CSS)](https://x.com/PigmentCSS) + + + +[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/mui/pigment-css.svg)](https://isitmaintained.com/project/mui/pigment-css 'Average time to resolve an issue') +[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/mui-org)](https://opencollective.com/mui-org) + + + +
+ - [Getting started](#getting-started) - [Why this project exists?](#why-choose-pigmentcss) - [Start with Next.js](#start-with-nextjs)