Skip to content

Commit c55f52c

Browse files
authored
docs: improve README.ms
1 parent f520c66 commit c55f52c

File tree

1 file changed

+43
-32
lines changed

1 file changed

+43
-32
lines changed

README.md

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,74 @@
11
# Windows Post-Install Script Generator
22

3-
A web-based tool that generates customized Windows post-installation batch scripts. Select from 115 software applications and 80 system configurations to create a personalized Windows setup script.
3+
A web-based tool that generates customized Windows post-installation batch scripts. Select from 115 software applications and 80 Windows configurations to create a personalized setup script.
4+
5+
## How to Use (Production)
6+
7+
Just open the live version:
8+
9+
👉 **https://kaic.me/win-post-install**
10+
11+
There you can:
12+
13+
1. Choose the apps and settings you want.
14+
2. Generate a `.bat` script.
15+
3. Download it and run on your fresh Windows install (USB or local machine).
16+
17+
Runs entirely in your browser — no installation required.
18+
19+
---
420

521
## Features
622

7-
- **115 Software Applications**: Curated collection across 13 categories including browsers, development tools, media players, productivity apps, and more
8-
- **80 System Configurations**: Optimize Windows settings for performance, privacy, visual customization, and gaming
9-
- **Cleanup Tools**: Remove Windows bloatware and unnecessary components safely
10-
- **One-Click Script Generation**: Generate ready-to-run batch scripts with your selections
11-
- **Windows 98-Inspired UI**: Nostalgic interface design with modern functionality
12-
- **No Installation Required**: Runs entirely in your browser
13-
- **Safe and Reversible**: All changes use official Windows tools (winget, PowerShell) and are reversible
23+
- **115 Software Applications:** Curated apps across 13 categories
24+
- **80 System Configurations:** Performance, privacy, UI, gaming tweaks
25+
- **Cleanup Tools:** Remove bloatware safely
26+
- **One-Click Script Generation:** Ready-to-run batch file
27+
- **Windows 98-Inspired UI:** Nostalgia + modern functionality
28+
- **Safe and Reversible:** Uses official Windows tools (`winget`, PowerShell)
29+
30+
---
1431

15-
## Demo
32+
## Live Demo
1633

17-
Visit the live application: [https://kaic.me/win-post-install](https://kaic.me/win-post-install)
34+
🔗 **https://kaic.me/win-post-install**
35+
36+
---
1837

1938
## Technologies
2039

21-
- **React 19**: Modern UI framework
22-
- **Vite**: Fast build tool and development server
23-
- **Tailwind CSS**: Utility-first CSS framework
24-
- **React Icons**: Comprehensive icon library
25-
- **Winget**: Windows Package Manager for software installation
26-
- **PowerShell**: Windows automation and system configuration
40+
- React 19
41+
- Vite
42+
- Tailwind CSS
43+
- React Icons
44+
- Winget
45+
- PowerShell
46+
47+
---
2748

28-
## Getting Started
49+
## Running Locally (Development Only)
50+
51+
You only need this if you plan to run or modify the source code.
2952

3053
### Prerequisites
3154

3255
- Node.js 18+ and npm
3356

34-
### Installation
57+
### Setup
3558

36-
1. Clone the repository:
3759
```bash
3860
git clone https://github.com/kaic/win-post-install.git
3961
cd win-post-install
40-
```
41-
42-
2. Install dependencies:
43-
```bash
4462
npm install
45-
```
46-
47-
3. Start the development server:
48-
```bash
4963
npm run dev
5064
```
5165

52-
4. Open your browser to `http://localhost:5173`
53-
54-
### Build for Production
55-
66+
Build
5667
```bash
5768
npm run build
5869
```
5970

60-
The production build will be output to the `dist/` directory.
71+
The production build will be outputed to the `dist/` directory.
6172

6273
## Usage
6374

0 commit comments

Comments
 (0)