Feature/responsive-cv-pdf-readme (#1)

* feat: ✨ resposive - cv-pdf - readme

README.md

@@ -1,36 +1,68 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# DevFolio: Your Customizable Developer Portfolio
 
-## Getting Started
+DevFolio is a modern, responsive, and customizable portfolio template for developers. With easy-to-edit markdown files, you can showcase your projects, skills, and experience in a professional and visually appealing way.
 
-First, run the development server:
+## Features
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+- 🎨 Modern and clean design
+- 🌓 Dark mode support
+- 📱 Fully responsive
+- ⚡ Built with Next.js for optimal performance
+- 🎭 Easy customization through markdown files
+- 📄 Automatic CV/resume generation
+- 🔗 Social media integration
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Quick Start
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+1. Fork this repository
+2. Clone your forked repository
+3. Navigate to the project directory
+4. Install dependencies:
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+   ```bash
+   npm install
+   ```
 
-## Learn More
+5. Start the development server:
 
-To learn more about Next.js, take a look at the following resources:
+   ```bash
+   npm run dev
+   ```
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+6. Open `http://localhost:3000` in your browser
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+## Customization
 
-## Deploy on Vercel
+### Personal Information
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+Edit the `personal-info.md` file in the `content` directory to update your name, role, and other personal details.
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+### Projects
+
+Add or modify projects in the `projects.md` file in the `content` directory. Each project should have a title, description, image, and link.
+
+### CV/Resume
+
+Update your experience, education, and skills in the `cv.md` file in the `content` directory.
+
+### Social Links
+
+Edit the `social-links.md` file in the `content` directory to add or modify your social media links.
+
+## Deployment
+
+You can easily deploy your portfolio using Vercel. Click the button below to deploy:
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fyourusername%2Fdevfolio)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is open source and available under the [MIT License](LICENSE).
+
+## Credits
+
+Created by CharlyAutomatiza with ❤️