Skip to content

Commit a710171

Browse files
authored
chore: update README
1 parent 25ea650 commit a710171

File tree

1 file changed

+8
-59
lines changed

1 file changed

+8
-59
lines changed

README.md

Lines changed: 8 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# WebHub
22

3+
CD-Labs main website published online at [www.charlesdoucet.com](www.charlesdoucet.com).
4+
35
A modern, minimalist web application built with pure TypeScript and Vite. This project showcases a clean architecture approach without heavy frameworks, focusing on performance and maintainability.
46

57
## 🚀 Features
68

79
- **Pure TypeScript Architecture** - No React, Vue, or Angular dependencies
8-
- **Modern CSS** - Custom CSS with CSS Grid, Flexbox, and CSS Custom Properties
9-
- **Responsive Design** - Mobile-first approach with fluid layouts
1010
- **Component-Based** - Modular TypeScript components for reusability
1111
- **Dynamic Routing** - Client-side routing system
12-
- **Content Management** - Flexible content structure for blog articles
13-
- **Markdown Support** - Rich text content with markdown-like syntax
1412
- **Performance Optimized** - Minimal bundle size and fast loading
1513

1614
## 🛠️ Tech Stack
@@ -72,57 +70,13 @@ This project demonstrates how to build a modern web application using:
7270

7371
### Installation
7472

75-
1. Clone the repository
76-
```bash
77-
git clone https://github.com/cd-bash/webhub.git
78-
cd webhub
79-
```
80-
81-
2. Install dependencies
8273
```bash
83-
npm install
74+
git clone https://github.com/cd-bash/webhub.git // 1. Clone the repository
75+
npm install // 2. Install dependencies
76+
npm run dev // 3. Start development server
77+
npm run build // 4. Build for production
8478
```
8579

86-
3. Start development server
87-
```bash
88-
npm run dev
89-
```
90-
91-
4. Build for production
92-
```bash
93-
npm run build
94-
```
95-
96-
## 📝 Content Management
97-
98-
The project features a flexible content management system:
99-
100-
- **Type-safe content** - All content is TypeScript-typed
101-
- **Markdown support** - Rich text with markdown-like syntax
102-
- **Flexible layouts** - Mix different content types in any order
103-
- **Asset management** - Optimized image and video handling
104-
105-
### Adding Content
106-
107-
Content is managed through TypeScript files in the `src/content/` directory. Each content type is fully typed for safety and autocomplete support.
108-
109-
## 🎨 Styling Architecture
110-
111-
CSS is organized using a scalable architecture:
112-
113-
- **Base styles** - Reset, variables, and typography
114-
- **Layout systems** - Reusable layout patterns
115-
- **Components** - Encapsulated component styles
116-
- **Utilities** - Helper classes and responsive utilities
117-
- **Views** - Page-specific styling
118-
119-
## 🌐 Browser Support
120-
121-
- Chrome (latest)
122-
- Firefox (latest)
123-
- Safari (latest)
124-
- Edge (latest)
125-
12680
## 📄 License
12781

12882
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -137,11 +91,10 @@ All visual content, including but not limited to:
13791
- Video content and animations
13892
- Logo designs and branding elements
13993
- UI/UX design layouts and visual compositions
140-
- Color schemes and design systems
14194

14295
**© 2025 CD-Labs. All rights reserved.**
14396

144-
The visual content and design elements of this website are proprietary and protected by copyright law. They may not be reproduced, distributed, or used in any form without explicit written permission from CD-Labs.
97+
The visual content and design elements of this website are proprietary and protected by copyrights. They may not be reproduced, distributed, or used in any form without explicit written permission from CD-Labs.
14598

14699
### Code License
147100

@@ -153,16 +106,12 @@ Any third-party assets used in this project retain their original licenses and c
153106

154107
---
155108

156-
For licensing inquiries regarding visual content, please contact: [your-email@cd-labs.com]
109+
For licensing inquiries regarding visual content, please contact: [charles.douc@gmail.com]
157110

158111
## 🤝 Contributing
159112

160113
This is a personal portfolio project. While the code is open source under the MIT License, the visual content and design are proprietary to CD-Labs.
161114

162-
## 👨‍💻 Author
163-
164-
**Charles Doucet** - [CD-Labs](https://github.com/cd-bash)
165-
166115
---
167116

168117
*Built with ❤️ using pure TypeScript and modern web standards*

0 commit comments

Comments
 (0)