diff --git a/README.md b/README.md index 26bf790..1c6f4ab 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ A professional, bilingual CV site with server-side PDF generation, HTMX interact **Open Source:** The code is MIT licensed and available for educational purposes. You're welcome to use it as a template or reference for your own projects. This repository is maintained as my personal CV site and may be modified without notice. -**Contributions:** This is a personal CV project and is feature-complete. I'm not seeking contributions, but you're welcome to use it as a template! If you find a critical security vulnerability, please follow the [SECURITY.md](SECURITY.md) process. +**Contributions:** This is a personal CV project and is feature-complete. I'm not seeking contributions, but you're welcome to use it as a template! If you find a critical security vulnerability, please follow the [SECURITY.md](doc/SECURITY.md) process. ## 📑 Table of Contents @@ -139,15 +139,16 @@ No code changes needed - just refresh browser! ## 📚 Documentation -- **[DEPLOYMENT.md](DEPLOYMENT.md)** - Production deployment guides (VPS, cloud platforms, systemd) -- **[CUSTOMIZATION.md](CUSTOMIZATION.md)** - Complete guide to customizing this template for your CV -- **[API.md](API.md)** - HTTP endpoints documentation and HTMX integration -- **[SECURITY.md](SECURITY.md)** - Security policy, vulnerability reporting, deployment considerations +- **[DEPLOYMENT.md](doc/DEPLOYMENT.md)** - Production deployment guides (VPS, cloud platforms, systemd) +- **[CUSTOMIZATION.md](doc/CUSTOMIZATION.md)** - Complete guide to customizing this template for your CV +- **[API.md](doc/API.md)** - HTTP endpoints documentation and HTMX integration +- **[SECURITY.md](doc/SECURITY.md)** - Security policy, vulnerability reporting, deployment considerations +- **[PRIVACY.md](doc/PRIVACY.md)** - Privacy policy and analytics disclosure - **[LICENSE](LICENSE)** - MIT License ## 🚀 Deployment -This project is production-ready with multiple deployment options. See **[DEPLOYMENT.md](DEPLOYMENT.md)** for complete guides. +This project is production-ready with multiple deployment options. See **[DEPLOYMENT.md](doc/DEPLOYMENT.md)** for complete guides. ### Systemd Service @@ -177,18 +178,18 @@ Deployment guides available for: - **AWS ECS** - Task definitions - **Railway / Render** - Auto-deploy configs -**See [DEPLOYMENT.md](DEPLOYMENT.md) for detailed instructions.** +**See [DEPLOYMENT.md](doc/DEPLOYMENT.md) for detailed instructions.** **Environment Configuration:** Copy `.env.example` to `.env` and customize: - `PORT` - Server port (default: 1999) - `GO_ENV` - Environment (development/production) - `TEMPLATE_HOT_RELOAD` - Enable template hot-reload in development -**Security:** See [SECURITY.md](SECURITY.md) for production deployment best practices. +**Security:** See [SECURITY.md](doc/SECURITY.md) for production deployment best practices. ## 🎨 Customization -**Want to use this template for your own CV?** See **[CUSTOMIZATION.md](CUSTOMIZATION.md)** for the complete guide! +**Want to use this template for your own CV?** See **[CUSTOMIZATION.md](doc/CUSTOMIZATION.md)** for the complete guide! ### Quick Start Customization @@ -197,7 +198,7 @@ Deployment guides available for: 3. **Adjust Templates:** Edit files in `templates/` directory 4. **Add Sections:** Update `internal/models/cv.go` and JSON files -The [CUSTOMIZATION.md](CUSTOMIZATION.md) guide includes: +The [CUSTOMIZATION.md](doc/CUSTOMIZATION.md) guide includes: - Complete JSON schema documentation - Visual customization (colors, fonts, layout) - Template modification examples @@ -225,7 +226,7 @@ This site uses **self-hosted Matomo analytics** to understand visitor behavior w - Respects "Do Not Track" browser settings - You can disable cookies in browser settings -See **[PRIVACY.md](PRIVACY.md)** for complete details and opt-out instructions. +See **[PRIVACY.md](doc/PRIVACY.md)** for complete details and opt-out instructions. --- @@ -237,7 +238,7 @@ See **[PRIVACY.md](PRIVACY.md)** for complete details and opt-out instructions. 1. **Matomo Site ID** in `templates/index.html` (line 644): Change `setSiteId` from `'4'` to your own 2. **Matomo Server URL** in `templates/index.html` (line 642): Change `https://matomo.drolo.club/` to your instance 3. **CSP Headers** in `internal/middleware/security.go`: Update allowed domains for your Matomo server -4. **OR remove Matomo entirely** if you don't want analytics (see [PRIVACY.md](PRIVACY.md#for-developers-using-this-code)) +4. **OR remove Matomo entirely** if you don't want analytics (see [PRIVACY.md](doc/PRIVACY.md#for-developers-using-this-code)) **Other recommended changes:** - Update all personal information in `data/cv-en.json` and `data/cv-es.json` @@ -245,7 +246,7 @@ See **[PRIVACY.md](PRIVACY.md)** for complete details and opt-out instructions. - Update `ALLOWED_ORIGINS` in `.env` for API protection - Customize colors and branding in `static/css/main.css` -See **[CUSTOMIZATION.md](CUSTOMIZATION.md)** for the complete customization guide. +See **[CUSTOMIZATION.md](doc/CUSTOMIZATION.md)** for the complete customization guide. ## 📄 License @@ -256,8 +257,8 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) ## 💬 Questions or Issues? - **Questions:** Feel free to fork and modify - this is a template! -- **Security Issues:** See [SECURITY.md](SECURITY.md) for reporting security vulnerabilities -- **Documentation:** Check [CUSTOMIZATION.md](CUSTOMIZATION.md) and [DEPLOYMENT.md](DEPLOYMENT.md) +- **Security Issues:** See [SECURITY.md](doc/SECURITY.md) for reporting security vulnerabilities +- **Documentation:** Check [CUSTOMIZATION.md](doc/CUSTOMIZATION.md) and [DEPLOYMENT.md](doc/DEPLOYMENT.md) ## 🙏 Acknowledgments