README updated

Author: nirnejak

README.md

@@ -2,8 +2,44 @@
   Next.js TypeScript Starter
 </h1>
 
+<p align="center">
+  A modern Next.js starter template with TypeScript, Tailwind CSS, and more
+</p>
+
 ---
 
+## Features
+
+- ⚡️ Next.js 15 with App Router
+- 🎨 Tailwind CSS with Typography plugin
+- 🔒 NextAuth.js (Auth.js) for authentication
+- 🗄️ Drizzle ORM with NeonDB integration
+- 📝 MDX support for content
+- 🎭 Framer Motion for animations
+- 🔔 Sonner for toast notifications
+- 🎵 use-sound for sound effects
+- 🎨 Akar Icons for beautiful icons
+- 🔍 SEO optimized(with metadata and schema.org)
+- 🎯 TypeScript for type safety
+- 🧹 ESLint + Prettier for code quality
+- 🐶 Husky for git pre commit
+- 🚀 View transitions for smooth page navigation
+
+## Project Structure
+
+```
+├── app/                 # Next.js app directory
+├── components/          # React components
+│   ├── atoms/          # Basic UI components
+│   └── ...
+├── hooks/              # Custom React hooks
+├── styles/             # Global styles
+├── utils/              # Utility functions
+├── public/             # Static assets
+├── assets/             # Project assets
+└── ...
+```
+
 ## Included
 
 - `not found page` page to handle 404 routes
@@ -14,6 +50,9 @@
 - `components/atoms/Button.tsx` a button component with variants
 - `hooks/useClickOutside` hook to check if user clicked outside the element
 - `hooks/useModal` hook to create modals, which can close with esc
+- `hooks/useDynamicHeight`
+- Drizzle ORM for database(with NeonDB)
+- NextAuth(or Auth.js) for Auth
 
 ## Additional Packages Used
 
@@ -25,6 +64,41 @@
 - use-sound - for using sounds
 - Class Variance Authority - for type-safely managing class names
 
+## Getting Started
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/nirnejak/nextjs-typescript-starter.git
+cd nextjs-typescript-starter
+```
+
+2. Install dependencies:
+
+```bash
+bun install
+```
+
+3. Copy the environment variables:
+
+```bash
+cp .env.example .env
+```
+
+4. Update the environment variables in `.env` with your configuration.
+
+5. Setup pre-commit hooks:
+
+```bash
+bun run prepare
+```
+
+6. Start the development server:
+
+```bash
+bun run dev
+```
+
 ## Available Scripts
 
 **Install Dependencies**
@@ -99,4 +173,32 @@ bun run build
 bun start
 ```
 
+## Configuration
+
+Update the `config.ts` file with your site's information:
+
+```typescript
+const config = {
+  baseUrl: "https://your-site.com",
+  appName: "Your App Name",
+  appDescription: "Your app description",
+  creator: "Your Name",
+  authorName: "Your Name",
+  authorUrl: "Your URL or Email",
+  keywords: ["your", "keywords"],
+  twitterSite: "@your-site",
+  twitterCreator: "@your-username",
+}
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
 ---
+
+Made with ❤️ by [Jitendra Nirnejak](https://github.com/nirnejak)