Skip to content

Commit

Permalink
📝 Update documentation with a roadmap
Browse files Browse the repository at this point in the history
  • Loading branch information
aryanprince committed Sep 18, 2024
1 parent 081b07b commit 00049e3
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,28 @@
# dev-db
# 📦 create-docker-db

## Description
## 📝 Description

A CLI to easily create DBs for local development using Docker Compose.
A CLI to easily create DBs for local development using Docker Compose. Currently supports MySQL and Postgres.

## Usage
## 🚀 Usage

```bash
npx dev-db
npx create-docker-db # or bunx create docker-db
```

## 🎯 Roadmap

### Features

- [x] Setup Changesets
- [ ] Display copy-pastable connection URLs for the created databases
- [ ] Modify existing Docker Compose files instead of overwriting them
- [ ] Add support for more databases (see below)
- [ ] Add support for more configurations (like custom container names based on project name)

### Support Additional Databases

- [ ] Add support for MongoDB
- [ ] Add support for Redis
- [ ] Add support for SQLite (easy but still)
- [ ] Add support for HTTP based DB services (like PlanetScale, Turso, etc.)

0 comments on commit 00049e3

Please sign in to comment.