From abec4e6108dff829b69f7f59ccd1c111ecc9bc4d Mon Sep 17 00:00:00 2001
From: Spxg <unsafe@outlook.es>
Date: Sat, 17 May 2025 10:06:50 +0800
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..679cca6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# SQLite Playground
+
+A SQLite Playground that runs entirely locally.
+
+## How it works
+
+Run SQLite as wasm in the browser using [`sqlite-wasm-rs`](https://github.com/Spxg/sqlite-wasm-rs).
+
+## About UI
+
+Users who have used [Rust Playground](https://play.rust-lang.org) will feel very familiar. 
+
+Because the layout and component design are derived from it, but rewritten using [leptos](https://leptos.dev).
+
+## Local deployment
+
+```sh
+npm install
+npx postcss --dir assets/module.postcss assets/module.css/**/*.css --base assets/module.css
+# Choose your preferred installation method
+# https://trunkrs.dev/#install
+cargo install trunk --locked
+trunk serve --open
+```