Update README.md

README.md

@@ -1,44 +1,45 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 
-## Getting Started
+# Todo-List 💳💰
 
-First, run the development server:
+<h2>This is a todolist app that developped with Next.js, Typescript, NextUI and TailwindCss</h2>
+
 
+https://github.com/masoumehmohebbi/next.js14-todo-list-pag-router/assets/88876100/8dbd4557-c53b-4557-9884-a0ea1d504273
 
-https://github.com/masoumehmohebbi/next.js14-todo-list-pag-router/assets/88876100/b592848b-3a62-43cd-b51d-5f783a30aa43
+Language: Typescript
+FrameWork: Next.js 14
+Next.js-Directory: Page Router
+Styling: NextUi & TailwindCss
+Authentication: Next_Auth
+Database: Mongodb
 
 
-```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 `pages/index.tsx`. The page auto-updates as you edit the file.
-
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
-
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
-
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+<h2>⛓ Links </h2>
+<ul>
+   <li>
+      <a href="https://github.com/masoumehmohebbi/masoumehmohebbi/next.js14-todo-list-pag-router">GitHub repository</a>
+   </li>
+   <li>
+      <a href="https://github.com/masoumehmohebbi/?tab=repositories">My other projects</a>
+   </li>
+</ul>
 
-## Learn More
 
-To learn more about Next.js, take a look at the following resources:
+<h2>⚙️ Development setup</h2>
+<p>1. First, you need to clone the project:</p>
 
-- [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.
+```
+git clone https://github.com/masoumehmohebbi/next.js14-todo-list-pag-router
+```
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+<p>2. Then, install required packages:</p>
 
-## Deploy on Vercel
+```
+npm i
+```
 
-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.
+<p>3. Finally, run the <code>dev</code> script to start the dev server:</p>
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+```
+npm run dev
+```