From 14361c7d809baa84abc36e483b39fbf6dddfbe5d Mon Sep 17 00:00:00 2001
From: Rodolphe Houdas <rodolphe@lunai.re>
Date: Mon, 16 Aug 2021 23:33:37 +0100
Subject: [PATCH] :memo: Add basic instructions

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index e69de29..e77ace0 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,15 @@
+# OpenSCAD-pyOptimizer
+
+Parse optimizer parameters from SCAD files.
+
+## Using the library
+
+Pull the repository and install the plugin with pip:
+
+```bash
+git clone https://forge.lunai.re/rodolphe/openscad-pyoptimizer
+cd openscad-pyoptimizer
+pip install -e .
+```
+
+You can then use the `customizer.py` to read an OpenSCAD file and display the parameters in JSON format.
\ No newline at end of file