From d6f005e8d197296593a7440b181719453ed6d8fc Mon Sep 17 00:00:00 2001
From: nicolas <821778+novalic@users.noreply.github.com>
Date: Fri, 21 Apr 2023 17:19:23 -0300
Subject: [PATCH] chore: updates readme

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

diff --git a/README.md b/README.md
index 2420e79..a877ae6 100644
--- a/README.md
+++ b/README.md
@@ -8,11 +8,27 @@ Skeleton of a backend Django App.
 apps/
     app_one/
         apputils/
+          misc.py
+          <some utils filename>.py
+          ...
         migrations/
+          ...
         models/
+          <my model>.py
+          <another model>.py
+          ...
         serializers/
+          <my serializer>.py
+          <anotoher serializer>.py
+          ...
         tests/
+          <my test file>.py
+          <anotoher test file>.py
+          ...
         views/
+          <my view>.py
+          <anotoher view>.py
+          ...
         urls.py
 project_name/
     settings/
@@ -25,3 +41,18 @@ utils/
 
 - Each package is located inside the apps package.
 - Each model, serializer, view is defined in a separate .py file.
+
+## Docker
+
+The app is intended to be run (but not exclusively) in a Docker container.
+There is a `docker-compose` and a `Makefile` to execute several useful actions.
+
+e.g. (Initialization):
+
+Clone the repo and execute:
+
+```shell
+$ make test
+```
+
+The docker-compose file will build an image and setup a database, then run the dummy tests. Now you can start building your app!