From 16ac4984ba31698a32c6288da95e791e8525d502 Mon Sep 17 00:00:00 2001
From: Jurgis Sakalauskas <jurgis.sakalauskas@cec.valantic.com>
Date: Fri, 4 Aug 2023 16:17:57 +0300
Subject: [PATCH] update readme

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

diff --git a/README.md b/README.md
index cbc904c..a9b78ab 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,28 @@ An API server for personal [KODI plugin](https://github.com/sakaljurgis/plugin.v
 
 A rewrite attempt from "vanilla" node.js into framework based (Nest.js).
 
-## License
-
-No licence
-
-## Migrations
+## Running the app
 
 ```bash
+$ cp .env.example .env
+
+# edit .env file to match your environment
+# make sure all folders exists
+
+# start docker containers
+$ docker-compose up -d
+```
+visit http://localhost:3000/if (or whatever port you have provided in .env file)
+kodi plugin should be able to connect to this server with the following settings:
+- api url: http://localhost:3000/api
+- video url: http://localhost:3000 (video url is old relic from previous versions, it is probably not used anymore)
+
+## Migrations (run inside docker container)
+
+```bash
+# enter docker container
+docker exec -it kodi-api-server_server_1 bash
+
 # create migration
 $ npm run typeorm:create-migration -name=CreateFilesTable
 
@@ -18,27 +33,10 @@ $ npm run typeorm:create-migration -name=CreateFilesTable
 $ npm run typeorm:run-migrations
 ```
 
-## Below are left from nest readme
-
-## Installation
-
-```bash
-$ npm install
-```
-
-## Running the app
-
-```bash
-# development
-$ npm run start
-
-# watch mode
-$ npm run start:dev
-
-# production mode
-$ npm run start:prod
-```
-
 ## Test
 
 this app is not tested 😞
+
+## License
+
+No licence