Skip to content

Commit

Permalink
update a little bit
Browse files Browse the repository at this point in the history
  • Loading branch information
ChakkritGit committed Nov 20, 2024
1 parent 5b5a2f4 commit 3b82343
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
Binary file added .github/workflows/npm-install.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pluto Theme Mode [![tag - 1.0.10](https://img.shields.io/badge/version-1.0.10-1271dc)](https://www.npmjs.com/package/pluto-theme-mode?activeTab=versions)
# Pluto Theme Mode [![tag - 1.0.10a](https://img.shields.io/badge/version-1.0.10a-1271dc)](https://www.npmjs.com/package/pluto-theme-mode?activeTab=versions)

pluto-theme-mode is a lightweight and versatile theme provider library for React, designed to make switching between light and dark modes smooth and effortless. Built with TypeScript, styled-components, and Context Hook, it supports multiple styling approaches—including inline class, Tailwind CSS, and styled-components—offering flexible options for theme-based designs. Ideal for developers looking to add dark mode functionality seamlessly, pluto-theme-mode provides a modern, intuitive solution for managing theme states and creating customizable user experiences. 🌃🌇

Expand All @@ -17,6 +17,13 @@ pluto-theme-mode is a lightweight and versatile theme provider library for React

## Quickstart

<div align="left">
<a href="https://github.com/ChakkritGit/pluto-theme-mode/blob/main/.github/workflows/npm-install.gif">
<img alt="npm-install" src="https://raw.githubusercontent.com/ChakkritGit/pluto-theme-mode/refs/heads/main/.github/workflows/npm-install.gif" width="193px" height="240px" />
</a>
</div>
<br>

**1. Install**

```shell
Expand Down Expand Up @@ -146,7 +153,7 @@ const App = () => {

return (
// wrap Component with ThemeProvider
// use theme prop set theme with theme.mode
// use theme prop set mode with theme.mode
<ThemeProvider theme={{ mode: theme.mode }}>
{Component}
</ThemeProvider>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "pluto-theme-mode",
"version": "1.0.10",
"version": "1.0.10a",
"description": "pluto-theme-mode is a lightweight and flexible theme provider library for React that makes switching between light and dark modes easy and seamless. Built with TypeScript, styled-components, and Context Hook, this library simplifies the process of managing theme states, allowing for a more intuitive and customizable theme experience. Ideal for developers who want to integrate dark mode functionality effortlessly, pluto-theme-mode provides a smooth and modern approach to theme switching.",
"main": "dist/cjs/index.js",
"module": "dist/esm/index.js",
Expand Down

0 comments on commit 3b82343

Please sign in to comment.