From bd80f4d7500822c685432b3e2bff37167a4ad767 Mon Sep 17 00:00:00 2001
From: "Angel M. Adames" <angelmadames@gmail.com>
Date: Mon, 1 Apr 2024 08:47:59 -0400
Subject: [PATCH] docs: Update README.md and Biome schema version

---
 README.md    | 81 +++++++++++++++++++++++++++++++++++++++++++++-------
 biome.json   |  2 +-
 package.json |  1 +
 3 files changed, 73 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index b85a0c4..8713303 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,88 @@
 <!-- omit in toc -->
-# DEMS - CLI
+# Development Environment Management System (DEMS)
+
+[![🧪 Tests](https://github.com/angelmadames/dems-cli/actions/workflows/tests.yml/badge.svg)](https://github.com/angelmadames/dems-cli/actions/workflows/tests.yml)
 
 <!-- omit in toc -->
 ## Contents
 
-- [Overview](#overview)
-- [Setup](#setup)
+- [🗒️ Overview](#️-overview)
+- [🔧 Setup](#-setup)
+- [🖍️ Style](#️-style)
+- [🏗️ Structure](#️-structure)
+  - [🟢 Commands](#-commands)
+  - [🔵 Config](#-config)
+  - [🟠 Utils](#-utils)
+
+## 🗒️ Overview
 
-## Overview
+DEMS is a generic CLI tool meant to assist teams to quickly get from onboarding
+to coding by automating the initialization process of an application (git clone,
+deps install, provisioning of required services like databases or mail servers)
+using Docker.
 
-This project was created using `bun init` in bun v1.0.23.
-[Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+DEMS is made with [Bun], [TypeScript] and [Commander.js].
 
-## Setup
+## 🔧 Setup
 
 To install dependencies:
 
-```bash
+```shell
 bun install
 ```
 
 To run:
 
-```bash
-bun run cli.ts
+```shell
+./cli.ts --help
 ```
+
+## 🖍️ Style
+
+Our chosen format and lint tool is [Biome]. For more information about our
+preset and custom rules configuration, see the [biome.json](./biome.json)
+file.
+
+## 🏗️ Structure
+
+The current version of DEMS in this repository is a modern adaptation of an internal
+tool with the same name that I made for [gbh.tech]. The original version was made
+purely with Bash scripts, which is the main motivation for this newer version, to
+extend its capabilities with a rich ecosystem and make it more accesible to developers.
+
+The structure of DEMS is simple: it has **commands** ([/src/commands](./src//commands/)),
+and those commands depend on **utilities** ([/src/utils](./src/utils/)) and **config
+files** ([/src/config](./src/config/)).
+
+### 🟢 Commands
+
+As you'd expect, `commands` are the protagonists of DEMS. They assist the software engineer
+in the various tasks needed to setup a local project and start working on it.
+
+Commands are instances of the Command class provided by [Commander.js], which are then
+added to the main `cli` Command object in the [./cli.ts](./cli.ts) file with `addCommand()`.
+
+> 💡 Execute `dems --help` to check all available commands.
+
+### 🔵 Config
+
+The DEMS Config is split into three (3) different contexts found in two different files: [./src/config/cli.ts](./src/config//cli.ts) and [./src/config/dems.ts](./src/config//dems.ts).
+
+- **CLI**: modifies the behavior of the CLI tool, without affecting any specific project.
+- **DEMS**: defines the configuration directives of DEMS for every project, in the form of a `config.json` file.
+- **Environment**: defines the blogal environment variables of DEMS that can affect all other configurations (all env vars start with a prefix `DEMS_` to avoid conflicts).
+
+### 🟠 Utils
+
+The Utils are simply re-usable functions that assist commands, they can go from simple things
+like normalizing a string, to more complex tags like generating a .env file from the config.json
+of the project or generating parameter for Docker Compose.
+
+For more information, check the [./src/utils](./src//utils/) directory.
+
+<!-- References -->
+[Bun]: https://bun.sh
+[TypeScript]: https://www.typescriptlang.org
+[Commander.js]: https://github.com/tj/commander.js
+[Biome]: https://biomejs.dev
+[gbh.tech]: https://gbh.tech
diff --git a/biome.json b/biome.json
index c3bbf79..c9f23ca 100644
--- a/biome.json
+++ b/biome.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.4.1/schema.json",
+  "$schema": "https://biomejs.dev/schemas/1.6.3/schema.json",
   "organizeImports": {
     "enabled": true
   },
diff --git a/package.json b/package.json
index 1120ca4..0b57900 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,6 @@
 {
   "name": "dems-cli",
+  "version": "0.0.1",
   "description": "DEMS (Development Environment Management System) CLI",
   "author": "Angel Adames <angeladames@hey.com>",
   "main": "dist/cli.js",