Update project readme file

Author: attarchi

README.md

@@ -1,36 +1,128 @@
-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).
+# Professional Developer Portfolio
+
+A modern, interactive portfolio website built with Next.js 14, featuring GitHub-style aesthetics and smooth scroll animations.
+
+[![codecov](https://codecov.io/gh/attarchi/attarchi.github.io/branch/master/graph/badge.svg)](https://codecov.io/gh/attarchi/attarchi.github.io)
+
+## Tech Stack
+
+- **Framework**: Next.js 14 (App Router)
+- **Styling**: Tailwind CSS
+- **UI Components**: shadcn/ui
+- **Animations**: Framer Motion
+- **Content**: MDX/Markdown
+- **Deployment**: GitHub Pages
+- **CI/CD**: GitHub Actions
+
+## Features
+
+- Interactive scroll-triggered animations
+- Professional GitHub-inspired design
+- Responsive layout for all devices
+- Blog system with MDX support
+- Dark/Light theme support
+- SEO optimized
+- Performance focused
 
 ## Getting Started
 
-First, run the development server:
+1. Clone the repository:
+```bash
+git clone https://github.com/attarchi/attarchi.github.io.git
+cd attarchi.github.io
+```
 
+2. Install dependencies:
+```bash
+yarn install
+```
+
+3. Run the development server:
 ```bash
-npm run dev
-# or
 yarn dev
-# or
-pnpm dev
-# or
-bun dev
 ```
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## Project Structure
+
+```
+/app              # Next.js app router pages
+/components       # Reusable React components
+/content/posts    # Blog posts in MDX format
+/lib             # Utility functions and hooks
+/public          # Static assets
+```
+
+## Development
 
-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.
+- `yarn dev` - Start development server
+- `yarn build` - Build for production
+- `yarn start` - Start production server
+- `yarn lint` - Run ESLint
+- `yarn type-check` - Run TypeScript type checking
 
-## Learn More
 
-To learn more about Next.js, take a look at the following resources:
+## Design System
 
-- [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.
+- **Typography**: JetBrains Mono (headings) and Inter (body)
+- **Colors**: GitHub-inspired palette with light/dark mode support
+- **Animations**: Scroll-triggered with Framer Motion
+- **Components**: Custom-built with shadcn/ui and Tailwind CSS
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
 
-## Deploy on Vercel
+## Deployment
+
+The site is automatically deployed to GitHub Pages using GitHub Actions. Each push to the main branch triggers a new deployment.
+
+### Manual GitHub Pages Setup
+
+1. **Repository Configuration**
+   - Go to your repository settings
+   - Navigate to "Pages" under "Code and automation"
+   - Set the source to "GitHub Actions"
+
+2. **Next.js Configuration**
+   Add the following to your `next.config.js`:
+   ```js
+   /** @type {import('next').NextConfig} */
+   const nextConfig = {
+     output: 'export',
+     basePath: '/<youname>.github.io',
+     images: {
+       unoptimized: true,
+     },
+   }
+   
+   module.exports = nextConfig
+   ```
+
+3. **Custom Domain (Optional)**
+   - Add your custom domain in repository settings
+   - Create a CNAME file in the `public` directory
+   - Update DNS settings with your domain provider
+
+### Deployment Verification
+
+After deployment:
+1. Wait for the GitHub Actions workflow to complete
+2. Visit `https://<youname>.github.io`
+3. Verify all pages and assets load correctly
+4. Check that all animations and interactions work
+5. Test the site on different devices and browsers
+
+
+### Deploy on Vercel
 
 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.
 
 Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+
+
+## Contributing
+
+Feel free to open issues or submit pull requests for any improvements.
+
+## License
+
+MIT License - feel free to use this code for your own portfolio!