From d1ab229b8b06e18fce9915430b553e3d535f8151 Mon Sep 17 00:00:00 2001 From: "Angel M. Adames" Date: Mon, 1 Apr 2024 08:47:59 -0400 Subject: [PATCH] docs: Update README.md and Biome schema version --- README.md | 38 ++++++++++++++++++++++++++++---------- biome.json | 2 +- 2 files changed, 29 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b85a0c4..db469f9 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,45 @@ -# 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) ## Contents -- [Overview](#overview) -- [Setup](#setup) +- [๐Ÿ—’๏ธ Overview](#๏ธ-overview) +- [๐Ÿ”ง Setup](#-setup) + +## ๐Ÿ—’๏ธ 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. + + +[Bun]: https://bun.sh +[TypeScript]: https://www.typescriptlang.org +[Commander.js]: https://github.com/tj/commander.js +[Biome]: https://biomejs.dev 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 },