add a simple doc

XiangpengHao · Nov 3, 2024 · b84b38f · b84b38f
1 parent e09d4bc
commit b84b38f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,16 @@
+# Parquet Explorer
+
 Online at: https://xiangpenghao.github.io/parquet-explorer
 
-Useful scripts:
+It compiles [parquet-rs](https://github.com/apache/arrow-rs) to WebAssembly and uses it to explore Parquet files.
+
+![screenshot](doc/parquet-explorer.gif)
+
+
+
+## Development
+
+Checkout the awesome [Leptos](https://github.com/leptos-rs/leptos) framework.
 
 ```bash
 trunk serve --open

diff --git a/doc/parquet-explorer.gif b/doc/parquet-explorer.gif