From caaa5fedf0991b01cce9ecf4c465a83b8a1e413c Mon Sep 17 00:00:00 2001
From: Francesco Esposito <33671357+frsposito@users.noreply.github.com>
Date: Thu, 5 Sep 2019 19:08:13 +0200
Subject: [PATCH] edit readme

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6d7b529..9a407dc 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,39 @@
-# umbrello-api
\ No newline at end of file
+# umbrello-api
+
+A rest API for umbrello-bot
+
+**Technologies**:
+
+- Node.js
+- express
+- mongodb
+
+## Installation
+
+1. Install `Node.js` and `npm`.
+2. Install `mongodb`.
+3. Clone this repository.
+4. Install dependencies with `npm install`
+5. Create env file or set environment variables. (read "Environment variables" paragraph)
+6. Build with `npm run build`.
+7. Start the server with `npm run serve`.
+
+
+### Environment Variables.
+```
+OWM_TOKEN=your-open-weather-map-token-api
+OWM_LANG=en
+OWM_UNITS=metric
+
+TELEGRAM_TOKEN=your-telegram-bot-token
+
+DB_HOST=mongodb://host:port/db
+DB_USER=user
+DB_PASSWORD=password
+```
+
+## License
+GPLv3
+
+---
+Made with ❤️ by Francesco Esposito ([@frsposito](https://github.com/frsposito))