Skip to content

Commit 5a6d1a9

Browse files
add usage.md
1 parent c457be5 commit 5a6d1a9

File tree

3 files changed

+32
-0
lines changed

3 files changed

+32
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ and use
9393
<img align="center" src="https://raw.githubusercontent.com/programming-with-ia/shadcn-theme-editor/master/screenshots/shadcn-theme-editor.png" alt="logo">
9494
</p>
9595

96+
## [How to Use the UI](usage.md)
97+
[usage.md](usage.md)
98+
9699
## Upcoming Features
97100

98101
- use [jln themes](https://ui.jln.dev/) directly in your project

screenshots/usage-pic.png

167 KB
Loading

usage.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<h1 align="center">Shadcn Theme Editor</h1>
2+
3+
## Usage
4+
<p align="center">
5+
<img align="center" src="https://raw.githubusercontent.com/programming-with-ia/shadcn-theme-editor/master/screenshots/usage-pic.png" alt="Shadcn Usage ScreenShot">
6+
</p>
7+
8+
### 1. Reset Button
9+
10+
- Click to **Reset the Theme**.
11+
- Press `⌘ + Click` to delete all themes stored in Local Storage.
12+
13+
### 2. Copy Button
14+
15+
- Click to **Copy the Current Theme** to your clipboard.
16+
17+
### 3. Color Picker Trigger
18+
19+
- Opens the color picker for the selected theme color.
20+
21+
### 4. Color Button & 5. Tooltip
22+
23+
- **Color Name/Title**: Displays the name of the color.
24+
- **Double-Click**: Copy the current color value to the clipboard.
25+
- **Hover**: Display the current value of the color in a tooltip.
26+
27+
### 6. Theme Changer
28+
29+
- Switch between theme modes: **System**, **Dark**, or **Light** using [`next-themes`](https://github.com/pacocoursey/next-themes).

0 commit comments

Comments
 (0)