Skip to content

Commit

Permalink
docs: Update README.md and Biome schema version
Browse files Browse the repository at this point in the history
  • Loading branch information
angelmadames committed Apr 1, 2024
1 parent d824578 commit aa0707a
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 11 deletions.
39 changes: 29 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,46 @@
<!-- 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)

## 🗒️ 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.

<!-- References -->
[Bun]: https://bun.sh
[TypeScript]: https://www.typescriptlang.org
[Commander.js]: https://github.com/tj/commander.js
[Biome]: https://biomejs.dev
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
@@ -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
},
Expand Down

0 comments on commit aa0707a

Please sign in to comment.