Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mayank1513 committed Jun 15, 2024
1 parent 3a23da7 commit 3637356
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@ Nextjs Darkmode is a versatile library crafted to fully utilize React 18 server

The `nextjs-themes` library was initially created to achieve a similar functionality to `next-themes` with React Server Components. While effective, it felt bulky for those supporting only dark/light mode. Thus, `nextjs-darkmode` was developed to offer a minimal footprint while utilizing Next.js Server Components, avoiding any flash of unthemed content, and ensuring theme synchronization with the server.

## Features
> For migration guide please refer [Project Wiki](https://github.com/react18-tools/nextjs-darkmode/wiki/1.-Migration-guide)
<details>
<summary>
<h2 style="display:inline-block">Features</h2>
</summary>

- ✅ Simple API to toggle between dark and light modes

Expand Down Expand Up @@ -44,7 +49,12 @@ Feel free to [request new features](https://github.com/react18-tools/nextjs-dark

Please consider starring [this repository](https://github.com/react18-tools/nextjs-darkmode) and sharing it with your friends.

## Getting Started
</details>

<details>
<summary>
<h2 style="display:inline-block">Getting Started</h2>
</summary>

### Installation

Expand Down Expand Up @@ -78,7 +88,7 @@ Import styles globally or within layout component.
import "nextjs-darkmode/css";
```

## Lite Version
### Lite Version

For a lighter version, use `nextjs-darkmode-lite`:

Expand All @@ -102,6 +112,8 @@ $ yarn add nextjs-darkmode-lite

> You need `r18gs` as a peer-dependency.
</details>

## Usage

> Please explore `examples` and `packages/shared-ui` for more working examples. (updates coming soon...)
Expand Down

0 comments on commit 3637356

Please sign in to comment.