From b85b1f0d560c8f8c44228e82cd04fa8c427d000e Mon Sep 17 00:00:00 2001
From: Bart van der Braak <bartvdbraak@gmail.com>
Date: Wed, 14 Jun 2023 02:20:19 +0200
Subject: [PATCH] docs: changed `README.md` with project info

---
 README.md | 77 ++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 50 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index f4da3c4..aa76d43 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,57 @@
-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).
+<div align="center">
+    <h1 align="center">hellob.art</h1>
+    <h5>a simple portfolio</h5>
+</div>
 
-## Getting Started
+<div align="center">
+  <a href="https://sonarcloud.io/api/project_badges/measure?project=bartvdbraak_hellob.art&metric=alert_status"><img src="https://sonarcloud.io/api/project_badges/measure?project=bartvdbraak_hellob.art&metric=alert_status" /></a>
+  <a href="https://github.com/bartvdbraak/hellob.art/deployments/activity_log?environment=Production"><img src="https://img.shields.io/github/deployments/bartvdbraak/hellob.art/production?label=vercel&logo=vercel" /></a>
+</div>
 
-First, run the development server:
+<div align="center">
+  <a href="https://hellob.art?ref=github">hellob.art</a>
+</div>
+<br/>
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
+## Installation
+
+To install the project and its dependencies, follow these steps:
+
+1.  Ensure you have `pnpm` installed on your system. If not, you can install it by running:
+
+    ```sh-session
+    npm install -g pnpm
+    ```
+
+2.  Run the following command to install the project dependencies:
+    ```sh-session
+    pnpm install
+    ```
+
+### Environment Variables
+
+After setting up the required services, you need to set the corresponding environment variables in the `/.env` file. To do this, follow these steps:
+
+1.  Make a copy of the `.env.example` file:
+
+    ```sh-session
+    cp .env.example .env
+    ```
+
+2.  Open the `.env` file in a text editor and populate the values for the services mentioned above.
+
+## Build
+
+To build the project, execute the following command:
+
+```sh-session
+pnpm build
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Run
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+To run the project locally, use the following command:
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
-
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [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.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## 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/deployment) for more details.
+```sh-session
+pnpm run dev
+```