From 1353755683cdcf1d7dc3cf9a39f846d4a7ce8d99 Mon Sep 17 00:00:00 2001
From: William Petit <wpetit@cadoles.com>
Date: Mon, 9 May 2022 14:07:39 +0200
Subject: [PATCH] chore: add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ed79421
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Formidable
+
+Web-based - but terminal compatible ! - little form editor using [JSONSchema](https://json-schema.org/) models.
+
+**Terminal compatible ?**
+
+The generated web UI does not use Javascript and can be used with terminal browsers like [w3m](https://en.wikipedia.org/wiki/W3m) or [lynx](https://en.wikipedia.org/wiki/Lynx_(web_browser)).
+
+## Install
+
+### Manually
+
+Download the pre-compiled binaries from the [releases page](https://github.com/Bornholm/formidable/releases) and copy them to the desired location.
+
+### Bash script
+
+```
+curl -sfL https://raw.githubusercontent.com/Bornholm/formidable/master/misc/script/install.sh | bash
+```
+
+It will download `frmd` to your current directory.
+
+#### Script available environment variables
+
+|Name|Description|Default|
+|----|-----------|-------|
+|`FORMIDABLE_VERSION`|Formidable version to download|`latest`|
+|`FORMIDABLE_DESTDIR`|Formidable destination directory|`.`|
+
+## Usage
+
+### Defining a schema
+
+### Using default values
+
+### Handling values update
+
+## Licence
+
+AGPL-3.0
\ No newline at end of file