Skip to content

Free, simple, and intuitive online database diagram editor and SQL generator.

Update Readme

1ilit28d265521242
diff --git a/README.md b/README.md
index 50bf2427..51afbc89 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,40 @@
-# drawDB
\ No newline at end of file
+<h3 align="center">
+ <img width="80" alt="Puter.com, The Personal Cloud Computer: All your files, apps, and games in one place accessible from anywhere at any time." src="./src/assets/icon-dark.png">
+</h3>
+
+<h3 align="center">Free, simple, and intuitive database design tool and SQL generator.</h3>
+
+<p align="center">
+ <a href="https://drawdb.vercel.app/">drawDB</a>
+ ·
+ <a href="https://discord.com/invite/8y7XUfcqR8">Discord</a>
+</p>
+
+<h3 align="center"><img width="700" style="border-radius:5px;" alt="demo" src="drawdb.gif"></h3>
+
+## drawDB
+
+DrawDB is a robust and user-friendly database entity relationship (DBER) editor right in your browser. Build diagrams with a few clicks, export sql scripts, customize your editor, and more without creating an account. See the full set of features [here](https://drawdb.vercel.app/).
+
+## Getting Started
+
+### Local Development
+
+```bash
+git clone https://github.com/drawdb-io/drawdb
+cd drawdb
+npm install
+npm run dev
+```
+
+### Build
+
+```bash
+git clone https://github.com/drawdb-io/drawdb
+cd drawdb
+npm install
+npm run build
+```
+
+Set up the [server](https://github.com/drawdb-io/drawdb-server) and environment variables according to `.env.sample` for the survey and bug report forms.
+
diff --git a/drawdb.gif b/drawdb.gif
new file mode 100644
index 00000000..1126254f
Binary files /dev/null and b/drawdb.gif differ
diff --git a/src/assets/icon-dark.png b/src/assets/icon-dark.png
new file mode 100644
index 00000000..75b86b26
Binary files /dev/null and b/src/assets/icon-dark.png differ