Skip to content

Commit 2a7a802

Browse files
committed
add README
1 parent 1e6b4c9 commit 2a7a802

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# QuickIME
2+
3+
**A fast, private, and simple web-based Input Method Editor that doesn’t suck.**
4+
5+
---
6+
7+
## 🚀 Features
8+
9+
- Zero-server IME: Runs 100% in your browser. No tracking, no back-end, no network calls.
10+
- Instant Romanization -> Characters: Type phonetic input (e.g. romaji) and get immediate candidate suggestions.
11+
- Persistent UI Settings saved in localStorage
12+
- Light / Dark / System Theme
13+
14+
---
15+
16+
## 💻 Getting Started
17+
18+
### Prerequisites
19+
20+
- Node.js >= 22
21+
- pnpm
22+
23+
### Clone & Install
24+
25+
```bash
26+
git clone https://github.com/xlc-dev/QuickIME.git
27+
cd QuickIME
28+
pnpm install
29+
```
30+
31+
### Local Development
32+
33+
```bash
34+
pnpm dev
35+
```
36+
37+
Open http://localhost:3000 and start typing!
38+
39+
### Production Build
40+
41+
```bash
42+
# Build the static site
43+
pnpm build
44+
45+
# Preview the production build locally
46+
pnpm preview
47+
```
48+
49+
---
50+
51+
## 🤝 Contributing
52+
53+
1. Fork it
54+
2. Create your feature branch (`git checkout -b feat/...`)
55+
3. Commit your changes (`git commit -m "feat: ..."`)
56+
4. Push to the branch (`git push origin feat/...`)
57+
5. Open a Pull Request
58+
59+
All contributions are welcome!
60+
61+
---
62+
63+
## 📜 License
64+
65+
GPL-3.0 © 2025 [xlc-dev](https://github.com/xlc-dev)

0 commit comments

Comments
 (0)