Skip to content

Commit 9bba961

Browse files
committed
chore: update readme
1 parent 3052fc1 commit 9bba961

1 file changed

Lines changed: 26 additions & 49 deletions

File tree

‎README.md‎

Lines changed: 26 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -41,54 +41,43 @@ finally start building
4141
you can start from:
4242

4343
```
44-
    ShaadKit
45-
        ↓
44+
ShaadKit
45+
↓
4646
build the product
4747
```
4848

4949
## ✨ Why ShaadKit?
5050

51-
Ordinary boilerplates are just a simple starting point. **ShaadKit** is a complete, opinionated foundation that solves every concern of a professional project from day one:
52-
53-
- ⚡ **Bun** as Package Manager — blazing-fast install & run
54-
55-
- 🧩 **Mantine v9** — powerful and accessible components
56-
57-
- 🧩 **Mantine Hooks** — 70+ production-ready hooks for state, UI, and browser APIs
51+
Ordinary boilerplates are just a simple starting point. **ShaadKit** is a complete, opinionated foundation that solves every concern of a professional project from day one:
5852

53+
- ⚡ **Bun** as Package Manager — blazing-fast install & run
54+
- 🧩 **Mantine v9** — powerful and accessible components
55+
- 🧩 **Mantine Hooks** — 70+ production-ready hooks for state, UI, and browser APIs
5956
- 📝 **Mantine Form** — simple, performant, and fully typed form management
60-
61-
- 🌍 **Next-intl** — internationalization (i18n) ready from the start
62-
57+
- 🌍 **Next-intl** — internationalization (i18n) ready from the start
6358
- 🔄 **TanStack Query** — powerful async state management & data fetching
64-
65-
- 📖 **Storybook 10** — component-driven development with MCP & A11y
66-
67-
- 🧪 **Vitest + Playwright** — fast and reliable testing
68-
69-
- 🎨 **Stylelint + ESLint (Antfu Config)** — top-tier code quality
70-
59+
- 📖 **Storybook 10** — component-driven development with MCP & A11y
60+
- 🧪 **Vitest + Playwright** — fast and reliable testing
61+
- 🎨 **Oxlint + Oxfmt** — blazing-fast linting & formatting, replacing ESLint and Stylelint
7162
- 🎯 **Tabler Icons** — 5000+ consistent, tree-shakable icons, fully integrated with Mantine
72-
73-
- 🔍 **Bundle Analyzer** — analyze and optimize your bundle
74-
75-
- ⚛️ **React 19 + React Compiler** — the latest React with auto-optimization
76-
77-
- ✅ **Arktype & Arkenv** — blazing-fast type-safe validation at runtime & build-time
63+
- 🔍 **Bundle Analyzer** — analyze and optimize your bundle
64+
- ⚛️ **React 19 + React Compiler** — the latest React with auto-optimization
65+
- ✅ **Arktype & Arkenv** — blazing-fast type-safe validation at runtime & build-time
66+
- 🟦 **TypeScript 7** — the next generation of TypeScript, with native performance
7867

7968
## 🛠️ Tech Stack
8069

8170
| Category | Technology |
8271
| --------------------- | --------------------- |
8372
| Framework | Next.js(React) |
84-
| Language | TypeScript |
73+
| Language | TypeScript 7 |
8574
| UI | Mantine |
8675
| Styling | PostCSS / CSS Modules |
8776
| Internationalization | next-intl |
8877
| Data Fetching | TanStack Query |
8978
| Component Development | Storybook |
9079
| Testing | Vitest + Playwright |
91-
| Code Quality | ESLint + Stylelint |
80+
| Code Quality | Oxlint + Oxfmt |
9281
| UI Hooks | Mantine Hooks |
9382
| Form Management | Mantine Form |
9483
| Icons | Tabler Icons |
@@ -126,26 +115,18 @@ bun install
126115
bun dev
127116
```
128117

129-
Then open your browser at: [http://localhost:3000](http://localhost:3000/)
118+
Then open your browser at: [http://localhost:3000](http://localhost:3000/)
130119

131120
## 🎯 Key Features
132121

133-
- ✅ **Production-Oriented** — optimized settings from the start
134-
135-
- ✅ **Component-Driven** — integrated Storybook for design & documentation
136-
137-
- ✅ **Testable** — Vitest + Playwright in a real browser
138-
139-
- ✅ **Accessible (A11y)** — Storybook A11y addon included
140-
141-
- ✅ **Multilingual** — full i18n support
142-
143-
- ✅ **Code Quality** — automatic lint & format with best-in-class configs
144-
145-
- ✅ **Bundle Optimization** — analyze and reduce output size
146-
147-
- ✅ **Integrated technologies** — The `Image` and `Anchor` components have been integrated with Next.js and Next-intl.
148-
122+
- ✅ **Production-Oriented** — optimized settings from the start
123+
- ✅ **Component-Driven** — integrated Storybook for design & documentation
124+
- ✅ **Testable** — Vitest + Playwright in a real browser
125+
- ✅ **Accessible (A11y)** — Storybook A11y addon included
126+
- ✅ **Multilingual** — full i18n support
127+
- ✅ **Code Quality** — automatic lint & format with **Oxlint + Oxfmt** for blazing-fast performance
128+
- ✅ **Bundle Optimization** — analyze and reduce output size
129+
- ✅ **Integrated technologies** — The `Image` and `Anchor` components have been integrated with Next.js and Next-intl.
149130
- ✅ **Type-Safe Environment** — runtime environment validation with Arkenv
150131

151132
## 🗺 Roadmap
@@ -159,18 +140,14 @@ The focus is on maintaining a small, reliable, and opinionated foundation rather
159140
We welcome contributions! Before submitting a PR, please:
160141

161142
1. Fork the project
162-
163143
2. Create a new branch (`git checkout -b feature/amazing-feature`)
164-
165144
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
166-
167145
4. Push to the branch (`git push origin feature/amazing-feature`)
168-
169146
5. Open a Pull Request
170147

171148
## 📄 License
172149

173-
This project is released under the **MIT** License.
150+
This project is released under the **MIT** License.
174151

175152
## ✒ Author
176153

0 commit comments

Comments
 (0)