commit 4ae6407239669b2bb178020383dc2ef121c00f80
Author: Alarig Le Lay <alelay@scaleway.com>
Date:   Thu Oct 17 15:23:53 2024 +0200

    Basic README
    
    Signed-off-by: Alarig Le Lay <alelay@scaleway.com>

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..122a0ea
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# What the scripts are used for
+`/usr/local/sbin/update-irr-filters.sh`     Has to be put in a cron
+`/usr/local/sbin/update-check-import.sh`    Is used to do generate the stuff common to all peers
+`/usr/local/sbin/generate-irr-filter.sh`    Is used to generate each peer configuration
+
+# Configuration files
+`/usr/local/etc/bird-peers-update.conf` is sourced for three variables:
+    * `PDB_API_KEY` which will be used to query the peeringdb api
+    * `BIRD_CONF_PATH` for the base dir of bird (freebsd and linux have different ones)
+    * `IXP_ASN` the ixp asn for the communities
+
+# Override some peers configuration
+If you want to add some configuration for some particular peers, you can do it like that:
+```
+root@lillix-rs2:~# cat /usr/local/etc/bird-override/bgp_208627_ALARIG_193_34_197_135.conf
+bfd on;
+root@lillix-rs2:~# cat /usr/local/etc/bird-override/bgp_208627_ALARIG_2001_7f8_6d__20_8627_1.conf
+bfd on;
+```