From 429d024f78904a82aabdfc1770bf4e15b7fd527c Mon Sep 17 00:00:00 2001
From: Gregory Trolliet <gregory@trolliet.info>
Date: Tue, 28 Apr 2020 21:50:23 +0200
Subject: [PATCH] [THEME] Improve README

---
 README.md | 80 +++++++++++++++++++++++++++++--------------------------
 1 file changed, 42 insertions(+), 38 deletions(-)

diff --git a/README.md b/README.md
index d27c299..79a0f2f 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,18 @@ baseurl = "https://yourdoma.in" # The base url of your Hugo website
 title = "Title"                 # The title of your website
 author = "Author"               # The author of the website
 language = "fr"
-theme = "idunn"                 # The Hugo theme
+theme = "snotra"                # The Hugo theme
+```
+
+### Menu
+
+The menu is generated following all the files in the root directory
+and the articles in the *blog* directory.
+To avoid the *blog* entry to be pluralized,
+add the following option to your config file:
+
+```toml
+pluralizeListTitles = false
 ```
 
 ### Description
@@ -36,18 +47,31 @@ You can use some parameters to fill meta tags and bases images:
 	description = "" # Description for the meta tag
 	favicon = ""     # Favicon URL
 	logo = ""        # Logo URL
+	keyword = ""     # Keywords for the meta tag
 ```
 
-### Colors
+### Home page
 
-It is possible to basicaly change some colors:
+The home page use one avatar, the name, one description and a list of social
+networks.
+For the social networks, see *Social Networks* chapter.
 
 ```toml
-[params.colors]
-	font = "black"       # General font color, default to black
-	background = "white" # General background color, default to white
-	main = "grey"        # Theme color, used for footer among others, default to grey
-	font_above = "white" # Used for font above *main* color, default to white
+[params]
+	author = "Author"     # The author of the website
+	info   = "Your infos" # Displayed under author name
+	avatar = "file.png"   # Placed in static/images
+```
+
+### Twitter:card
+
+Twitter cards are automaticly generated.
+If you want tho have the twitter:site meta generated,
+add the following option to your config file:
+
+```toml
+[params]
+	twitterUser = "youruser" # Your Twitter account without @
 ```
 
 ### Custom CSS
@@ -57,38 +81,18 @@ It is possible to basicaly change some colors:
 	custom_css = ["style.css"] # Your own css files
 ```
 
-### Contact footer
-
-If you want to have some informations about you in the footer,
-you can set it with thoses parameters:
-
-```toml
-[params.contact]
-	email = "mail@serve.ur"    # The mail of your company
-	phone = "+41 22 123 45 67" # The phone number of your company
-	address = "Your address"   # The address of your company
-```
-
 ### Social Networks
 
-You can also set some of your networks accounts.
-Thoses options are availables:
+You can also set some of your networks accounts to display on the home page.
+Every social network (or not so network) have to be described with thoses
+options:
 
 ```toml
-[params.social]
-	500px = ""
-	codepen = ""
-	facebook = ""
-	flickr = ""
-	github = ""
-	gitlab = ""
-	instagram = ""
-	linkedin = ""
-	mastodon = ""
-	peertube = ""
-	pinterest = ""
-	pixelfed = ""
-	tumblr = ""
-	twitter = ""
-	youtube = ""
+[[params.social]]
+	name   = "Title of the entry"            # Title, used on hover
+	icon   = "facebook"                      # Icon to use
+	weight = 1                               # Sort order
+	url    = "https://www.facebook.com/user" # Link to your account
 ```
+
+You can also add some non social elements, you only need to have an icon.