From 9f9597b5fb1ae049bdd4274ebf7c1a972ab90684 Mon Sep 17 00:00:00 2001
From: Alnotz <alnotz@mailo.com>
Date: Thu, 13 Mar 2025 23:00:03 +0100
Subject: [PATCH] Read-me added
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Histoire de comprendre l’outil.
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3c78796
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# JQRCode
+
+Petite implémentation de la bibliothèque QRCode Generator développée par Nayuki.
+Voir le site du projet : https://www.nayuki.io/page/qr-code-generator-library.
+
+L’application est, après paquetage, une archive JAR nommée `jqrcode` et
+ exécutable comme suit :
+```bash
+java -jar target/jqrcode --help
+```
+
+Elle peut encoder un texte `TEXT` comme argument.
+```bash
+java -jar target/jqrcode -s $TEXT
+```
+
+Si cet argument est `-`, `jqrcode` lit l’entrée standard.
+
+
+```bash
+echo $TEXT | java -jar target/jqrcode -s -
+```
+
+Pour prendre peu d’espace mémoire, opter pour le profil Maven `prod`.
\ No newline at end of file