From befbf7c485d77bf2faf615ef8be2b45a672702d2 Mon Sep 17 00:00:00 2001
From: augustin64 <me.git@augustin64.fr>
Date: Wed, 3 Apr 2024 18:40:14 +0200
Subject: [PATCH] Add README.md

---
 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..e51c9c2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# isbn-sort
+
+Ce programme a pour but d'indexer rapidement une bibliothèque en utilisant la base de données ISBN d'openLibrary notamment.
+
+# Binary Eye
+
+Il est possible d'entrer les numéros manuellement ou via une application de scan comme BinaryEye [[PlayStore](https://play.google.com/store/apps/details?id=de.markusfisch.android.binaryeye)] [[f-droid](https://f-droid.org/en/packages/de.markusfisch.android.binaryeye/)].
+
+Une fois installée, configurez comme suit:
+
+Scan:
+- [x] Scanner en continu
+- [ ] Afficher les données en mode continu
+- [x] Vibrer à la détection
+
+Transfert:
+- [x] Transférer les scans
+- URL de transfert: `http://<addresse du serveur>/submit-isbn?isbn=`
+- Type de requête: `GET` et ajouter simplement le contenu
+
+Vous recevrez un macaron vous indiquant si il faut finir de taper les données à la main sur l'interface web (`http://<addresse du serveur>/`)
+
+> Attention, cela suppose que le serveur expose ses ports, pour cela, utilisez la commande suivante:  
+> `flask run --host=0.0.0.0 --port=5000`
\ No newline at end of file