docs: readme

zxch3n · May 19, 2023 · 54382fa · 54382fa
1 parent 2096ac9
commit 54382fa
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/rust/crates/tidy-tree/README.md b/rust/crates/tidy-tree/README.md
@@ -0,0 +1,15 @@
+# Tidy Tree Visualization
+
+![Show Case](https://i.ibb.co/hM6mnZS/202206150143.gif)
+
+[**See the introduction blog here** 🔗](https://zxch3n.com/tidy/tidy/)
+
+![](https://i.ibb.co/nbhZSQ7/image.png)
+
+Tidy is designed specifically for tree layout. Graph and DAG data are not supported.
+
+The layout algorithm is based on paper _"Drawing non-layered tidy trees in linear time"_.
+
+```
+A. van der Ploeg, “Drawing non-layered tidy trees in linear time,”Software: Practice and Experience, vol. 44, no. 12, pp. 1467–1484, 2014, doi: 10.1002/spe.2213.
+```