From aac07e9b5b8d3a4f48b6e26e32bf7f9d1fdfb5dc Mon Sep 17 00:00:00 2001
From: Gabriele Musco <gabmus@disroot.org>
Date: Wed, 14 Apr 2021 11:27:24 +0200
Subject: [PATCH] updated readme for iconlinks and supported icons

---
 README.md | 42 +++++++++++++++++++++++-------------------
 1 file changed, 23 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index bc95f52..3f47205 100644
--- a/README.md
+++ b/README.md
@@ -57,29 +57,11 @@ summaryLength = 70  # number of words for article summaries
     plausibleScriptUrl = "https://something.com/..."
     plausibleDomain = "gabmus.org"
 
-    # the links array shows links with icons (if explicitly supported)
-    # it's an array of arrays containing two strings: name and link
-    # the supported icons are:
-    #    gitlab
-    #    gnome
-    #    youtube
-    #    email
-    #    twitter
-    #    instagram
-    #    facebook
-    #    github
-    #    linkedin
-    #    telegram
-    #    phone
-    #    rss
-
-
     # WARNING: deprecated! Use [[menu.icons]] instead, look below
     # links = [
     #     ["GitLab", "https://gitlab.com/gabmus"],
     #     ["GNOME", "https://gitlab.gnome.org/gabmus"],
-    #     ["YouTube", "https://youtube.com/TechPillsNet"],
-    #     ["Email", "mailto:gabmus@disroot.org"]
+    #     ["YouTube", "https://youtube.com/TechPillsNet"]
     # ]
 
     # you can customize all of the colors in this theme
@@ -125,6 +107,28 @@ summaryLength = 70  # number of words for article summaries
     home = ["HTML", "JSON"]
 ```
 
+### Supported icons
+
+For the `[[menu.icons]]` menu. They match identifier, name and url can be whatever. Here's a list of supported identifiers:
+
+- gitlab
+- gnome
+- youtube
+- email
+- twitter
+- instagram
+- facebook
+- github
+- linkedin
+- telegram
+- xmpp
+- pleroma
+- peertube
+- matrix
+- mastodon
+- phone
+- rss
+
 ## Inject custom content
 
 Ficurinia supports injecting custom content into the theme. There are several files you can create in `layouts/partials/inject` that will be included inside the theme in different places.