From 7c1f9c37b1c89e9eb397d974dbac21695252beed Mon Sep 17 00:00:00 2001
From: Rick <rick@gnous.eu>
Date: Wed, 3 Feb 2021 22:21:10 +0100
Subject: [PATCH] Ajout README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..500b7ae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Thème pour Pelican
+
+Ce thème a été en premier designé par [Eban](https://eban.bzh) avant d’être refait à ma sauce. Je me suis aussi beaucoup inspiré de [medius](https://github.com/onur/medius).
+
+## Installation
+
+Pour l’installation, suivez la [documentation officielle](https://docs.getpelican.com/en/4.5.4/pelican-themes.html).
+
+## Variables
+
+Vous pouvez définir une description sur la page auteur ainsi que des liens vers Twitter, Github, Mastodon et Gitea : 
+
+```
+NUIR_AUTHORS = {
+    'John': {
+        "description": "Lorem ipsum",
+        "links": (('mastodon', 'link'),
+                  ('github', 'link')),
+    }
+}
+```
+
+## Support de plugins
+
+Ce thème ne supporte pour l’instant que le plugin [Series](https://github.com/getpelican/pelican-plugins/tree/master/series).