From 391e4c1267cda388fe2bb1bfe55b8e6ad82e8bb2 Mon Sep 17 00:00:00 2001
From: Bruno21 <bruno@clicclac.info>
Date: Sat, 2 Nov 2024 13:46:44 +0100
Subject: [PATCH] README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..50ebf72
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# bashbird
+
+Script that queries a SQLite database about a bird and returns various information (vernacular name, English name, family, order and links to [oiseaux.net](https://oiseaux.net)).
+
+
+
+#### 1) bashbirds.sh
+
+<u>Usage</u>: 
+
+./bashbird.sh -b etourneau
+
+<u>Others files</u>:
+
+- Oiseaux europe.xlsm: export from Oiseaux.net website
+- Oiseaux europe.csv:same as format .csv
+- insert.sh: script to create birds.db database from .csv export (Usage: ./insert.sh)
+- birds.db: SQLite database
+- liste_oiseaux.html: html export
+- liste_oiseaux.md: markdown export
+- Transparent300px.png: usefull for markdown export (table width)
+
+<u>Options</u>:
+
+- -b <bird>: a bird to search
+- -b all: search for all birds
+- -m: export markdown
+- -w: export html
+- -h: help
+
+Notes:
+
+- insert.sh deletes and recreates the database each time it is launched (no update)
+
+
+