From 3ed0d68f45421fe95799d41cbf07a483420ae3ad Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20SALVI?= <beastie@unixyourbrain.org>
Date: Thu, 19 Dec 2024 18:28:08 +0100
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a3f6bbd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Custom Dashboard
+
+## Configure dashboard
+
+All config links and options are in `assets/config.json`
+
+## Use with firefox
+
+To use as firefox newtab, install this plugin :
+https://addons.mozilla.org/en-US/firefox/addon/new-tab-override/
+
+## Update CVE feed
+
+To update CVE feed, use cron or systemd.timer to get : https://cvefeed.io/rssfeed/latest.xml
+