Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
yukukotani committed Oct 13, 2024
1 parent 699a273 commit b9607cc
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ A dead simple CSS-in-JS library for React 19 or higher.

## Features

- **Familiar API**: Both Style Prop and Styled Function like styled-components are supported
- **Familiar API**: Both styled-components-like Styled Function and Style Prop are supported
- **Typed Theme**: Auto-completes your design token
- **RSC Support**: It just work. Nothing bothers you
- **RSC Support**: It just works. Nothing bothers you
- **No Build Step**: No need to set up build configuration
- **Small Runtime:** It's 1.7 kb minified & gzipped
- **Atomic CSS**: Generates optimized stylesheet to keep your stylesheet small
- **Atomic CSS**: Generates optimized stylesheet to keep your distribution small

## Installation

Expand Down Expand Up @@ -89,7 +90,7 @@ declare module "just-styled" {
}
```

Then, put ThemeProvider on the top of your component tree (e.g., `layout.tsx` on Next.js).
Then, put ThemeProvider at the top of your component tree (e.g., `layout.tsx` on Next.js).

```tsx
// import the config you defined
Expand All @@ -109,9 +110,9 @@ export default function RootLayout({
}
```

Now, you can use your token.
Now, you can use your tokens with auto-completion.

```
```tsx
const StyledBox = styled("div", {
backgroundColor: "$colors.bg",
padding: "$spaces.md",
Expand Down

0 comments on commit b9607cc

Please sign in to comment.