From 8bb34f5a2b894ba0de1ce0c84be2c14eae6b4b1b Mon Sep 17 00:00:00 2001
From: Ruben Arrebola <ruben.arre6@gmail.com>
Date: Fri, 17 Jun 2022 23:18:31 +0200
Subject: [PATCH] Added some documentation

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

diff --git a/README.md b/README.md
index 8d899e0..72beebf 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,51 @@
 # Personal Web
+My personal and professional web made with Python and Django.
+
+![Heroku](https://heroku-badge.herokuapp.com/?app=rarrebola-personalweb)
+
+## Requirements
+1. Docker and Docker Compose installed on your machine
+2. Python, Django and PostgreSQL knowledge
+
+## Getting started
+1. Clone the repository
+```bash
+git clone https://github.com/ruben69695/personalweb.git
+```
+2. Open the root of the project in your terminal
+```bash
+cd personalweb
+```
+3. Export in your system environment a new secret key necessary for docker compose, you can [generate a new one](https://djecrety.ir/)
+```bash
+export DJANGO_SECRET_KEY="Your new secret key goes here"
+```
+3. Build and stand up the services using docker compose
+```bash
+docker compose up --build -d
+```
+4. Now [open your browser](http://127.0.0.1:8000/)
+5. Easy and enjoy 🍻
+
+## Languages and versions
+- Python 3.9.13
+- Django 4.0.4
+- pip 20.3.4
+- Postgresql 14.3
+
+## Development environment
+- Debian Bullseye 11
+- VSCodium v1.86.0
+- NVIM v0.4.4
+
+## Architecture
+- Server - Client
+
+## Production Deployment
+- Heroku Platform
+
+## Runs on
+- Linux
+- MacOS
+- Windows
+- Docker