diff --git a/README.md b/README.md index a2a3e75..c97df2f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ +Great — here's the **updated `README.md`** file with your requested **"Getting Started"** section added cleanly while preserving the existing content: + +--- + +```markdown ## OpenxAI Frontend https://openxai.org @@ -7,10 +12,56 @@ Website interface to participate in the OpenxAI Initiative 2025. ## Commands ``` + bun i bun run dev bun run build bun run start -``` + +```` It is recommended to use bun, but you can also replace it with npm in the commands above. + +--- + +## 🚀 Getting Started + +### Prerequisites + +- [Node.js](https://nodejs.org/) (v16 or higher) +- [Bun](https://bun.sh/) (recommended runtime) + +### Installation + +1. Clone the repository: + ```bash + git clone https://github.com/OpenxAI-Network/openxai-frontend.git + cd openxai-frontend +```` + +2. Install dependencies: + + ```bash + bun install + ``` + +3. Run the development server: + + ```bash + bun run dev + ``` + +4. Open your browser and go to: + + ``` + http://localhost:3000 + ``` + +You're now ready to explore and contribute! + +``` + +--- + +Let me know if you want to add a **"Contributing"** section as well to make the PR even stronger. +```