From 870273b4d6da526161f30ced2c430300b84360a7 Mon Sep 17 00:00:00 2001 From: ArnauACR Date: Fri, 30 May 2025 22:01:50 +0200 Subject: [PATCH] docs(readme): rewrite README with human tone and setup guide --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3069a2b --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# πŸ“š Book Collection Manager + +A simple and modern web app to manage your personal book collection. Built with React and Vite. + +## 🌟 What You Can Do + +- πŸ“– View all your books in a responsive grid +- βž• Add new books to the collection +- ✏️ Edit existing book details +- ❌ Delete books you don’t need anymore +- πŸ“± Use it comfortably on mobile or desktop +- 🎨 Clean and modular styling with CSS Modules +- πŸ”„ Connect to a backend to keep everything in sync + +## πŸ› οΈ Tech Stack + +- **React** for the UI +- **Vite** as the build tool and dev server +- **CSS Modules** for scoped styles +- **Vitest** for testing +- **ESLint + Prettier** for clean code +- **Husky** for Git hooks and automation + +## πŸ“‹ Book Data Structure + +```ts +type Book = { + id: number; + title: string; + author: string; + year: number; + status: 'pending' | 'in progress' | 'read'; +}; +```