From 36efb53aaede38389aa3fcaa0bd0ea2868c1d8cc Mon Sep 17 00:00:00 2001
From: Jonas Gunz <himself@jonasgunz.de>
Date: Sat, 14 Jan 2023 02:40:35 +0100
Subject: README

---
 README.md | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 5f92c88..c64f62f 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,26 @@
-# gridfinity-scad
+# oscad-gridfinity
 
 [GridFinity](https://gridfinity.xyz/) implementation for [OpenSCAD](https://openscad.org/)
 
+![Bottom View](img/bottom.png)
+
+Create fully parameterized Templates for GridFinity.
+
+`gridfinity(<x>, <y>, <z>, lip=<>, magnets=<>);`
+
+* **x, y** Vertical size in *GridFinity* units
+* **z** Height in GridFinity units (`z * 7mm`). This in excluding the base and stacking lip.
+* **lip** `true/false` Sets wether to put a stacking lip on top. Only works with z >= 1.
+* **magnets** `true/false` Sets wether to put holes for magnets in the base.
+
 ## Example
 
 ```scad
 use <gridfinity.scad>
 
-// Arguments are in GridFinity units
 gridfinity(2, 1, 2, lip=true, magnets=false);
 ```
+
+## License
+
+Licensed under the MIT License. Consult `LICENSE`.
-- 
cgit v1.2.3