update README.md

README.md

@@ -1,3 +1,47 @@
-### Project Status
+# Portfolio Template
 
-This branch is currently under maintenance and not yet fully ready for production use. It will be ready very soon. Please refer to the [`v2`](https://github.com/zougari47/portfolio-template/tree/v2) branch.
+![](/src/assets/100lighthouse.png)
+
+Deploy your portfolio in 5 minutes with ease, built with Astro and TailwindCSS.
+
+![](/src/assets/screenshot.png)
+
+## Table of Contents
+
+- [Portfolio Template](#portfolio-template)
+  - [Table of Contents](#table-of-contents)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+  - [Running the Project](#running-the-project)
+
+## Prerequisites
+
+- [Node.js]() - v18.17.1 or v20.3.0 or higher. ( v19 is not supported.)
+- Text editor - We recommend [VS Code]() with our Official Astro extension.
+- Terminal - Astro is accessed through its command-line interface
+- [pnpm](https://pnpm.io)(or you can use npm/yarn)
+- [Git]()
+
+## Installation
+
+1. Fork the repository
+1. Clone the repo:
+   ```sh
+   git clone https://github.com/yourUsername/portfolio-template.git
+   ```
+1. Navigate to the project directory:
+   ```sh
+   cd portfolio-template
+   ```
+1. Install dependencies:
+   ```sh
+   pnpm install
+   ```
+
+## Running the Project
+
+Start the development server:
+
+```sh
+pnpm dev
+```