Updated readme

README.md

@@ -1,13 +1,36 @@
-# My Server Status
-My Server Status is a REST API that provides realtime information about your server's hardware. It's meant to be executed with Node.js on the host.
+<h1 align="center">
+  <img src="https://github.com/JGeek00/my-server-status-app/raw/master/assets/other/banner.png" />
+</h1>
 
-⚠️ CURRENTLY UNDER DEVELOPMENT ⚠️
+<h5 align="center">
+  REST API that provides system information
+</h5>
 
-## How to deploy
-[Deployment instructions.](https://github.com/JGeek00/my-server-status-api/wiki/Deployment-instructions)
+<br>
+
+<h6 align="center">
+  <a href="https://github.com/JGeek00/my-server-status-app">My Server Status application repository<a/>
+</h6>
 
 <br>
 <br>
+
+<p>
+My Server Status works thanks to <a href="https://systeminformation.io/">Systeminformation</a>, a Node.js library that exposes hardware status and specifications. 
+</p>
+
+<br>
+
+## How to deploy
+[Deployment instructions.](https://github.com/JGeek00/my-server-status-api/wiki/Deployment-instructions)
+## How to develop
+⚠️ The API requires root access on Windows and Linux ⚠️
+1. Clone this repository.
+2. The recommended Node.js version is ``v16.19.1``.
+3. Run ``npm install``.
+4. The API by default starts on port 3000. If you want to use another port, create a .env file and declare there the ``PORT`` variable with the desired port.
+5. Run ``npm run dev`` to start the API.
+
 <br>
 <br>
 <b>Created by JGeek00</b>