docs(readme): update docs

README.md

@@ -6,9 +6,15 @@
 </h1>
 
 <p align="center">
-<i>A tool for developing in a secure and reproducible environment</i>
+<i>A tool for developing in a secure, issolated and reproducible environment</i>
 </p>
 
+## Table of Contents
+
+Click on the menu right before `README.md` as shown in the image below.
+
+<img width=300px  src="media/toc.png" alt="toc">
+
 ## About
 
 A tool for developing applications in a secure and reproducible environment with virtual machines using a Docker-like workflow.
@@ -102,7 +108,30 @@ make install-deps-manjaro && sudo make install
 make install-deps-ubuntu && sudo make install
 ```
 
-For any other linux distribution install runtime dependencies manually.
+#### Install on any other linux distribution
+
+Install runtime dependencies manually and run the command below:
+
+```sh
+sudo make install
+```
+
+It's highly recommended for any other linux distro than manjaro and ubuntu to import and run an image from virtualbox gui before running vedv to guarantee that virtualbox is working properly.
+
+Download an alpine image
+
+```sh
+wget --header='User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' 'https://onedrive.live.com/download?resid=DBA0B75F07574EAA%21272&authkey=!AP8U5cI4V7DusSg' -qO alpine-inv.ova
+```
+
+Import the image from virtualbox gui:
+
+- Open Virtualbox
+- Click on File menu > Import Appliance
+- Import the image `alpine-inv.ova`
+- Start the `alpine-x86_64` virtual machine
+
+If you have any problem running vedv on your linux distro, it can be a missing dependency, please open a Bug issue.
 
 ## Configure
 
@@ -307,7 +336,7 @@ vedv container start -w todo-101
 
   You should see the todo list manager app
 
- <img width=500px  src="media/todo-list-manager.png" alt="todo list manager">
+ <img width=300px  src="media/todo-list-manager.png" alt="todo list manager">
 
 ```sh
 vedv container rm --force todo-101
@@ -675,6 +704,33 @@ are created from the scratch, here are the steps:
 We encourage you to read the CaC scripts to see what they do
 inside the vm.
 
+## Registry
+
+The registry is a Nextcloud instance, you can host your own registry, Nextcloud
+is free and open source software.
+
+The scripts for provision and configuration are located at
+`icac/nextcloud/vultr.prod/nextcloud-aio`.
+
+If you want to host your own registry on Vultr you must have a vultr account
+(I am not associated with vultr), then follow the steps below:
+
+- Copy and edit the .env file, inside the .env look for the section `icac/nextcloud/vultr`
+
+```sh
+cp .env.sample .env
+vim .env
+```
+
+- Provision and Configure the registry
+
+```sh
+make registry-prod-setup
+```
+
+If you want to host your own registry on any other cloud provider, you can reuse
+the CaC script and write your IaC script for provisioning.
+
 ## Contributing
 
 Contributions, issues and feature requests are welcome!
@@ -755,8 +811,6 @@ For Ubuntu:
 make OS=ubuntu configure
 ```
 
-For any other linux distribution install runtime and development dependencies manually.
-
 #### Setup registry development service
 
 Execute the command below to provision and configure the registry development service
@@ -872,3 +926,22 @@ make commit
 ## Show your support
 
 Give a ⭐️ if this project helped you!
+
+## Use Cases
+
+### ydf
+
+ydf is a dotfiles manager+ that uses vedv for developing.
+
+ydf is the kind of tool that make changes to your system, install apps and write config files,
+so it needs to be tested in a secure, issolated and reproducible environment, to avoid damaging
+your system and to guarantee that the changes made by ydf are reproducible always on a clean
+system during testing.
+
+You should open and see the 4 files below available on ydf project to understand how to use vedv
+during development:
+`Makefile`, `tools/ct-clean-exec`, `Vedvfile`,`.vedvfileignore`
+
+Start with the Makefile at: <https://github.com/yunielrc/ydf/blob/master/Makefile>
+
+Good luck.

README.md.tpl

@@ -4,9 +4,15 @@
 </h1>
 
 <p align="center">
-<i>A tool for developing in a secure and reproducible environment</i>
+<i>A tool for developing in a secure, issolated and reproducible environment</i>
 </p>
 
+## Table of Contents
+
+Click on the menu right before `README.md` as shown in the image below.
+
+<img width=300px  src="media/toc.png" alt="toc">
+
 ## About
 
 A tool for developing applications in a secure and reproducible environment with virtual machines using a Docker-like workflow.
@@ -76,7 +82,30 @@ make install-deps-manjaro && sudo make install
 make install-deps-ubuntu && sudo make install
 ```
 
-For any other linux distribution install runtime dependencies manually.
+#### Install on any other linux distribution
+
+Install runtime dependencies manually and run the command below:
+
+```sh
+sudo make install
+```
+
+It's highly recommended for any other linux distro than manjaro and ubuntu to import and run an image from virtualbox gui before running vedv to guarantee that virtualbox is working properly.
+
+Download an alpine image
+
+```sh
+wget --header='User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' 'https://onedrive.live.com/download?resid=DBA0B75F07574EAA%21272&authkey=!AP8U5cI4V7DusSg' -qO alpine-inv.ova
+```
+
+Import the image from virtualbox gui:
+
+- Open Virtualbox
+- Click on File menu > Import Appliance
+- Import the image `alpine-inv.ova`
+- Start the `alpine-x86_64` virtual machine
+
+If you have any problem running vedv on your linux distro, it can be a missing dependency, please open a Bug issue.
 
 ## Configure
 
@@ -267,7 +296,7 @@ vedv container start -w todo-101
 
   You should see the todo list manager app
 
- <img width=500px  src="media/todo-list-manager.png" alt="todo list manager">
+ <img width=300px  src="media/todo-list-manager.png" alt="todo list manager">
 
 ```sh
 vedv container rm --force todo-101
@@ -635,6 +664,33 @@ are created from the scratch, here are the steps:
 We encourage you to read the CaC scripts to see what they do
 inside the vm.
 
+## Registry
+
+The registry is a Nextcloud instance, you can host your own registry, Nextcloud
+is free and open source software.
+
+The scripts for provision and configuration are located at
+`icac/nextcloud/vultr.prod/nextcloud-aio`.
+
+If you want to host your own registry on Vultr you must have a vultr account
+(I am not associated with vultr), then follow the steps below:
+
+- Copy and edit the .env file, inside the .env look for the section `icac/nextcloud/vultr`
+
+```sh
+cp .env.sample .env
+vim .env
+```
+
+- Provision and Configure the registry
+
+```sh
+make registry-prod-setup
+```
+
+If you want to host your own registry on any other cloud provider, you can reuse
+the CaC script and write your IaC script for provisioning.
+
 ## Contributing
 
 Contributions, issues and feature requests are welcome!
@@ -678,8 +734,6 @@ For Ubuntu:
 make OS=ubuntu configure
 ```
 
-For any other linux distribution install runtime and development dependencies manually.
-
 #### Setup registry development service
 
 Execute the command below to provision and configure the registry development service
@@ -795,3 +849,22 @@ make commit
 ## Show your support
 
 Give a ⭐️ if this project helped you!
+
+## Use Cases
+
+### ydf
+
+ydf is a dotfiles manager+ that uses vedv for developing.
+
+ydf is the kind of tool that make changes to your system, install apps and write config files,
+so it needs to be tested in a secure, issolated and reproducible environment, to avoid damaging
+your system and to guarantee that the changes made by ydf are reproducible always on a clean
+system during testing.
+
+You should open and see the 4 files below available on ydf project to understand how to use vedv
+during development:
+`Makefile`, `tools/ct-clean-exec`, `Vedvfile`,`.vedvfileignore`
+
+Start with the Makefile at: <https://github.com/yunielrc/ydf/blob/master/Makefile>
+
+Good luck.