Skip to content

Commit d962d92

Browse files
committed
📝 Update README with refined branding and improved layout
Enhance documentation with more consistent styling and clearer structure - Rename project header to highlight SignalRGB integration - Update section icons for better visual hierarchy - Refine feature icons to be more descriptive - Improve formatting with proper list spacing - Standardize code block presentation - Polish overall documentation flow for better readability
1 parent 5569549 commit d962d92

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# ✨ LightScript Workshop ✨
2-
31
<div align="center">
42

3+
# 🌠 LightScript Workshop for SignalRGB 🔮
4+
55
![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
66
![Three.js](https://img.shields.io/badge/Three.js-000000?style=for-the-badge&logo=three.js&logoColor=white)
77
![WebGL](https://img.shields.io/badge/WebGL-990000?style=for-the-badge&logo=webgl&logoColor=white)
88
![Vite](https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white)
99

10-
*Create stunning RGB lighting effects with modern tools*
10+
_Create stunning RGB lighting effects with modern tools_
1111

1212
</div>
1313

1414
LightScript Workshop is a modern TypeScript framework for creating beautiful RGB lighting effects for [SignalRGB](https://signalrgb.com/). Transform the way you build Lightscripts with a type-safe, component-based approach featuring hot reloading, WebGL integration, and an efficient build system.
1515

16-
## 💫 Features
16+
## Features
1717

1818
- **🔷 Modern TypeScript** - Full type safety prevents runtime errors
1919
- **🔮 Three.js Integration** - Powerful WebGL rendering capabilities
2020
- **⚡ Hot Reloading** - Instant visual feedback while coding
21-
- **🎛️ Declarative Controls** - Define UI elements with simple HTML
22-
- **🚀 Optimized Build Pipeline** - Production-ready effects
21+
- **🕹️ Declarative Controls** - Define UI elements with simple HTML
22+
- **⚙️ Optimized Build Pipeline** - Production-ready effects
2323
- **🧪 Testing Framework** - Maintain quality with Vitest
2424

25-
## 🚀 Quick Start
25+
## 🌐 Quick Start
2626

2727
```bash
2828
# Clone the repository
@@ -56,6 +56,7 @@ The framework includes these demonstration effects:
5656
A ray-marched tunnel effect with dynamic colors and style options.
5757

5858
**Key features:**
59+
5960
- Ray marching in fragment shader
6061
- Multiple color schemes
6162
- Dynamically adjustable parameters
@@ -65,13 +66,15 @@ A ray-marched tunnel effect with dynamic colors and style options.
6566
A wave-based RGB effect showcasing smooth animation and minimal resource usage.
6667

6768
**Key features:**
69+
6870
- Sine wave generation
6971
- Multiple color modes
7072
- Optimized for performance
7173

7274
## 💻 Development Workflow
7375

7476
1. **Create** a new effect directory in `src/effects/your-effect-name/`
77+
7578
```
7679
effects/your-effect-name/
7780
├── fragment.glsl # Shader code
@@ -82,18 +85,20 @@ A wave-based RGB effect showcasing smooth animation and minimal resource usage.
8285
2. **Register** your effect in `src/index.ts`
8386

8487
3. **Develop** with live reloading
88+
8589
```bash
8690
npm run dev
8791
```
8892

8993
4. **Build** for SignalRGB
94+
9095
```bash
9196
EFFECT=your-effect-name npm run build
9297
```
9398

9499
5. **Import** the generated HTML file into SignalRGB
95100

96-
## 🏗️ Creating a Custom Effect
101+
## 🔬 Creating a Custom Effect
97102

98103
Creating a new effect is easy with the LightScript framework:
99104

@@ -105,7 +110,7 @@ Creating a new effect is easy with the LightScript framework:
105110

106111
Check the [Developer Guide](/docs/developer-guide.md) for a complete walkthrough.
107112

108-
## 🛠️ Building & Deployment
113+
## ️ Building & Deployment
109114

110115
### Building a Single Effect
111116

@@ -151,4 +156,4 @@ Created by [Stefanie Jane 🌠](https://github.com/hyperb1iss)
151156

152157
If you love lightscript-workshop, star the repo and [buy me a Monster Ultra Violet](https://ko-fi.com/hyperb1iss)! ⚡️
153158

154-
</div>
159+
</div>

0 commit comments

Comments
 (0)