From 315092d132147a5c4c9f9daa1bae15f01b72ef6e Mon Sep 17 00:00:00 2001
From: Daniel Dirks <dandirks@web.de>
Date: Tue, 6 Jun 2023 08:45:58 +0200
Subject: [PATCH] Add README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..54e76d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# devdb
+
+Fire up a local testing database from a dump in no time.
+
+[![MIT License](https://img.shields.io/github/license/danieldirks/devdb.svg)](LICENSE)
+
+
+## Features
+
+* Easy setup of local dev databases without the hassle.
+* Loads a dump on startup, so you don't have to worry how to get your data in.
+* Supports MySQL, MariaDB and PostgreSQL.
+* Uses docker to start temporary databases without cluttering up your device.
+* Lets you export to share, customize and set up on other machines.
+
+
+## Setup
+
+Make sure docker is installed and run `curl -sSf https://raw.githubusercontent.com/danieldirks/devdb/main/devdb > ~/.local/bin/devdb`.
+
+To update or uninstall, simply remove the file and load it again.
+
+
+## Usage
+
+1. `devdb dump.sql`
+2. wait
+3. connect
+
+It tries its best to figure out the database management system for you by searching for one of the supported databases at the beginning of the dump file. In some cases you may still need to specify it manually: `devdb --base mysql dump.sql`.
+
+You can customize things like user and password and can export `devdb`s. More can be found by running `devdb help`.
+
+Save time and have fun!
+
+
+## License
+
+The project is licensed under the [MIT License](LICENSE).