Skip to content

Commit 870273b

Browse files
committed
docs(readme): rewrite README with human tone and setup guide
1 parent d76153e commit 870273b

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# 📚 Book Collection Manager
2+
3+
A simple and modern web app to manage your personal book collection. Built with React and Vite.
4+
5+
## 🌟 What You Can Do
6+
7+
- 📖 View all your books in a responsive grid
8+
- ➕ Add new books to the collection
9+
- ✏️ Edit existing book details
10+
- ❌ Delete books you don’t need anymore
11+
- 📱 Use it comfortably on mobile or desktop
12+
- 🎨 Clean and modular styling with CSS Modules
13+
- 🔄 Connect to a backend to keep everything in sync
14+
15+
## 🛠️ Tech Stack
16+
17+
- **React** for the UI
18+
- **Vite** as the build tool and dev server
19+
- **CSS Modules** for scoped styles
20+
- **Vitest** for testing
21+
- **ESLint + Prettier** for clean code
22+
- **Husky** for Git hooks and automation
23+
24+
## 📋 Book Data Structure
25+
26+
```ts
27+
type Book = {
28+
id: number;
29+
title: string;
30+
author: string;
31+
year: number;
32+
status: 'pending' | 'in progress' | 'read';
33+
};
34+
```

0 commit comments

Comments
 (0)