From d335531e67103ba9527fc674a13a015a532ce17b Mon Sep 17 00:00:00 2001
From: Miguel Alejandro Salgado Zapien <ekiim@ekiim.xyz>
Date: Tue, 23 May 2023 21:32:28 -0700
Subject: [PATCH] Added readme video

---
 README.md | 29 ++++++++++-------------------
 1 file changed, 10 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 7db80e4..fb355e7 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,15 @@
-# README
+> *NOTE*, this project uses [`just`](https://just.systems/man/en/) as a task runner, and `docker compose` in order to spin up a `neo4j` database.
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+Once you make sure you have just install you can run:
 
-Things you may want to cover:
+```
+$ just build
+$ just migrate
+$ just run
+```
 
-* Ruby version
+Beware that `migrate` might fail the first time, because `neo4j` takes longer to start during it's first execution.
 
-* System dependencies
+If you want to verify the functionality, you could try and opening the postman collection `Grillo Rails Test.postman_collection.json`, which contains collection variables to parametrize the actual endpoint for the rails api.
 
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
+[Here is a demo video](https://youtu.be/G4j8IrI8noQ)