juanatsap
5e132e7ec7
- Add clear disclaimers: personal site, not a template - Update CONTRIBUTING.md: not seeking contributions - Remove all Docker files and references (11 files) - Rewrite DEPLOYMENT.md without Docker (VPS/cloud focus) - Add comprehensive API documentation with verified endpoints - Add complete CUSTOMIZATION guide - Add project status sections to all major docs - Clarify MIT license but personal use intent Created documentation files: - API.md (70KB) - Complete API reference with live testing - API-QUICK-REFERENCE.md - Quick command reference - DEPLOYMENT.md (45KB) - VPS, cloud, manual deployment (no Docker) - CUSTOMIZATION.md (38KB) - Complete customization guide - PROJECT-DOCUMENTATION-SUMMARY.md - Complete project overview This is my personal CV site. While code is public (MIT), it's designed for my personal use, not as a template.
81 lines
2.9 KiB
Markdown
81 lines
2.9 KiB
Markdown
# Using This CV Template
|
|
|
|
## 📌 Project Status
|
|
|
|
**This is a personal CV project and portfolio piece.** It's feature-complete and maintained as a showcase of production-grade Go and HTMX development.
|
|
|
|
## 🎯 Want to Use This Template?
|
|
|
|
You're welcome to:
|
|
|
|
### ✅ Fork and Customize
|
|
|
|
1. **Fork this repository** to your own GitHub account
|
|
2. **Clone your fork** to your local machine
|
|
3. **Follow the [CUSTOMIZATION.md](CUSTOMIZATION.md) guide** to adapt it for your CV
|
|
4. **Deploy** using instructions in [DEPLOYMENT.md](DEPLOYMENT.md)
|
|
|
|
### ✅ Learn and Reference
|
|
|
|
- Study the code architecture
|
|
- Use it as a reference for Go + HTMX projects
|
|
- Adapt patterns and approaches for your own projects
|
|
|
|
### ✅ Share and Star
|
|
|
|
- ⭐ **Star the repository** if you find it useful
|
|
- 🔗 **Share it** with others who might benefit
|
|
- 📝 **Link to it** in your own projects
|
|
|
|
## 🚫 Not Accepting Contributions
|
|
|
|
**I'm not actively seeking contributions to this repository** for the following reasons:
|
|
|
|
1. **Personal Project:** This is my personal CV, customized for my specific needs
|
|
2. **Feature Complete:** The project meets all my requirements
|
|
3. **Portfolio Piece:** It's maintained as a showcase, not a collaborative project
|
|
|
|
## 🔒 Security Vulnerabilities
|
|
|
|
**Exception:** If you discover a **critical security vulnerability**, please report it privately following the [SECURITY.md](SECURITY.md) process.
|
|
|
|
I take security seriously and will address legitimate security issues promptly.
|
|
|
|
## 💡 Have a Feature Idea?
|
|
|
|
If you have an idea that would benefit this CV template:
|
|
|
|
1. **Implement it in your fork** - It's MIT licensed!
|
|
2. **Share your fork** - Let others benefit from your improvements
|
|
3. **Open source is about freedom** - You're free to take this in any direction you want
|
|
|
|
## 🤝 Alternative: Build Your Own
|
|
|
|
If you're looking to contribute to open-source projects, consider:
|
|
|
|
- **Finding projects actively seeking contributors** - Check "good first issue" tags
|
|
- **Creating your own CV template** - Use this as inspiration and make it even better!
|
|
- **Contributing to the libraries this uses** - HTMX, chromedp, and the Go ecosystem always welcome contributors
|
|
|
|
## 📚 Resources
|
|
|
|
- **[CUSTOMIZATION.md](CUSTOMIZATION.md)** - Complete guide to adapting this template
|
|
- **[DEPLOYMENT.md](DEPLOYMENT.md)** - How to deploy your own version
|
|
- **[API.md](API.md)** - Understanding the HTTP endpoints
|
|
- **[SECURITY.md](SECURITY.md)** - Security best practices
|
|
- **[LICENSE](LICENSE)** - MIT License (use freely!)
|
|
|
|
## 🙏 Thank You!
|
|
|
|
Thank you for your interest in this project! The fact that you're here means the project is serving its purpose as a useful example and template.
|
|
|
|
**Go build something amazing with it!** 🚀
|
|
|
|
---
|
|
|
|
**Questions about customization?** Check [CUSTOMIZATION.md](CUSTOMIZATION.md)
|
|
|
|
**Want to deploy your own version?** See [DEPLOYMENT.md](DEPLOYMENT.md)
|
|
|
|
**Need help?** The documentation is comprehensive, but feel free to fork and experiment!
|