Skip to content

Commit faf4cb7

Browse files
committed
main README adjustments
1 parent 0c18856 commit faf4cb7

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

packages/pigment-react/README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Pigment CSS is a zero-runtime CSS-in-JS library that extracts the colocated styl
44

55
- [Getting started](#getting-started)
66
- [Why this project exists?](#why-choose-pigment-css)
7-
- [Next.js](#nextjs)
8-
- [Vite](#vite)
7+
- [Next.js](#nextjs-starter-template)
8+
- [Vite](#vite-starter-template)
99
- [Basic usage](#basic-usage)
1010
- [Creating styles](#creating-styles)
1111
- [Creating components](#creating-components)
@@ -35,9 +35,7 @@ Pigment CSS addresses the needs of the modern React developer by providing a zer
3535
Compared to its predecessors, Pigment CSS offers improved DX and runtime performance (though at the cost of increased build time) while also being compatible with React Server Components.
3636
Pigment CSS is built on top of [WyW-in-JS](https://wyw-in-js.dev/), enabling us to provide the smoothest possible experience for Material UI users when migrating from Emotion in v5 to Pigment in v6.
3737

38-
### Next.js
39-
40-
#### Starter template
38+
### Next.js - Starter template
4139

4240
Use the following commands to create a new Next.js project with Pigment CSS set up:
4341

@@ -83,9 +81,7 @@ Finally, import the stylesheet in the root `layout.tsx` file:
8381
}
8482
```
8583

86-
### Vite
87-
88-
#### Starter template
84+
### Vite - Starter template
8985

9086
Use the following commands to create a new Vite project with Pigment CSS set up:
9187

@@ -134,7 +130,7 @@ Finally, import the stylesheet in the root `main.tsx` file:
134130

135131
## Basic usage
136132

137-
> You must configure Pigment CSS with [Next.js](#nextjs) or [Vite](#vite) first.
133+
**You must configure Pigment CSS with [Next.js](#nextjs) or [Vite](#vite) first.**
138134

139135
### Creating styles
140136

@@ -371,7 +367,7 @@ const Heading = styled('h1')<{ isError?: boolean }>({
371367
Use the `keyframes` API to create reusable [animation keyframes](https://developer.mozilla.org/en-US/docs/Web/CSS/@keyframes):
372368

373369
```js
374-
import { keyframes } from '@mui/zero-runtime';
370+
import { keyframes } from '@pigment-css/react';
375371

376372
const fadeIn = keyframes`
377373
from {
@@ -390,7 +386,7 @@ function Example1() {
390386
The call to the `keyframes` function will be replaced with a unique string that represents the CSS animation name. It can be used with `css` or `styled` too.
391387

392388
```js
393-
import { css, styled, keyframes } from '@mui/zero-runtime';
389+
import { css, styled, keyframes } from '@pigment-css/react';
394390

395391
const fadeIn = keyframes(...);
396392

0 commit comments

Comments
 (0)