summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md95
1 files changed, 95 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f431771
--- /dev/null
+++ b/README.md
@@ -0,0 +1,95 @@
+# 🚗 CustomWorks Website
+
+Official website for **CustomWorks** - professional car detailing, wrapping, and tuning services based in Bydgoszcz, Poland.
+
+## About CustomWorks
+
+**CustomWorks** specializes in comprehensive car care and customization services, offering:
+
+- **Car detailing** - professional paint restoration, interior cleaning, and ceramic coatings
+- **Paint protection films (PPF)** - invisible protection against scratches and damage
+- **Car wrapping** - color change and vinyl wrapping services
+- **Visual tuning** - exterior and interior styling modifications
+- **Ceramic coatings** - graphene, quartz, and ceramic protection layers
+- **Invisible wipers** - revolutionary windshield protection
+- **Engine bay cleaning** - professional engine compartment detailing
+- **Premium materials** - working with high-quality products and techniques
+
+### Company Details
+- **Owner**: CustomWorks
+- **Address**: Bydgoszcz, Miedzyń, Poland
+- **Phone**: +48 790-209-770
+- **Website**: https://www.customworks.pl
+
+### Services
+CustomWorks offers a complete range of automotive care services, from basic detailing to advanced protection and customization solutions.
+
+## Website Technology
+
+This website is built with:
+- **[Astro 5.0](https://astro.build/)** - Modern static site generator
+- **[Tailwind CSS](https://tailwindcss.com/)** - Utility-first CSS framework
+- **TypeScript** - Type-safe development
+- **Responsive design** - Optimized for all devices
+- **SEO optimized** - Built-in meta tags, sitemap, and Open Graph support
+
+## Development
+
+### Prerequisites
+- Node.js 18.17.1 or higher
+- npm or yarn
+
+### Getting Started
+
+1. **Clone the repository**
+ ```bash
+ git clone <repository-url>
+ cd customworks.com
+ ```
+
+2. **Install dependencies**
+ ```bash
+ npm install
+ ```
+
+3. **Start development server**
+ ```bash
+ npm run dev
+ ```
+ The site will be available at `http://localhost:4321`
+
+### Available Commands
+
+| Command | Description |
+|---------|-------------|
+| `npm run dev` | Start development server |
+| `npm run build` | Build for production |
+| `npm run preview` | Preview production build |
+| `npm run check` | Check for errors |
+| `npm run fix` | Fix linting and formatting issues |
+
+## Project Structure
+
+```
+src/
+├── components/ # Reusable UI components
+│ ├── widgets/ # Page-specific widgets
+│ ├── ui/ # Basic UI components
+│ └── common/ # Common components (header, footer, etc.)
+├── layouts/ # Page layouts
+├── pages/ # Website pages
+├── assets/ # Images, styles, and other assets
+└── config.yaml # Site configuration
+```
+
+## Deployment
+
+This website is configured for deployment on Vercel. The build process creates optimized static files ready for production.
+
+## License
+
+This project is proprietary software owned by CustomWorks. All rights reserved.
+
+---
+
+**CustomWorks** - Professional car detailing and customization services in Bydgoszcz and surrounding areas.