Skip to content

Commit

Permalink
update Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
mayank1513 committed Jun 24, 2024
1 parent d4962ab commit 7597e7d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ This project was inspired by next-themes. Unlike next-themes, `nextjs-themes` do

> See [Getting Started](./guides/getting-started.md)
> Want Lite Version? [![npm bundle size](https://img.shields.io/bundlephobia/minzip/nextjs-themes-lite)](https://www.npmjs.com/package/nextjs-themes-lite) [![Version](https://img.shields.io/npm/v/nextjs-themes-lite.svg?colorB=green)](https://www.npmjs.com/package/nextjs-themes-lite) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/nextjs-themes-lite.svg)](https://www.npmjs.com/package/nextjs-themes-lite)
> In case you are using `r18gs` in your project, you may use lite version which requires `r18gs` as a peerDependency.
## Migration

> Refer to the [migration guide](./guides/migration.md).
Expand Down
2 changes: 1 addition & 1 deletion guides/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Migration Guide
- If you have been using these components, they will have no effect. We recommend removing them.
- There is no need to use sibling selectors. Without `NextJsSSGThemeSwitcher` or `NextJsServerTarget`, you are free to use any target, whether as a wrapper or a sibling.

### Breaking Changes
### Breaking Changes - these should only affect a very small fraction of library users

- `ForceColorScheme` and `ForceTheme` are no longer exported from `nextjs-themes` or `nextjs-themes/client`. Use `nextjs-themes/force-color-scheme` or `nextjs-themes/force-theme` instead.
- The class names for `ColorSwitch` have been shortened.
Expand Down

0 comments on commit 7597e7d

Please sign in to comment.