From b8c8e24ea1cb758e5931a91a541fcb62ed12c726 Mon Sep 17 00:00:00 2001
From: Francesco <tomaselli.fr@gmail.com>
Date: Mon, 22 Apr 2024 14:08:06 +0200
Subject: [PATCH] Theme Update

---
 README.md           | 87 ++++++++++++++++++++++++++++++++++++++++++---
 assets/css/vars.css |  2 +-
 2 files changed, 83 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 95ed497..c5fc059 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,87 @@
 ![banner](misc/readme.png)
 
-## Installation
-git..
+The theme is keeped as simple as possible on purpose. There are no fancy headers, cards, or stuff like that. 
+The fonts in use are Literata and Monaspace.
 
-## Features
-...
+Tags are intentionally omitted, have a look at the sample coinfiguration at the bottom to remove them. 
+
+## Example website
+
+
+
+## Installation
+
+To receive updates, add the theme as a submodule: 
+```
+git submodule add git@github.com:tomfran/typo.git themes/typo
+```
+
+Otherwise you can clone the repo and copy it manually to yout theme folder.
 
 ## Configuration
-...
\ No newline at end of file
+
+Here is an example configuration:
+
+```toml
+baseURL = 'https://example.org/'
+languageCode = 'en-us'
+disableKinds = ['taxonomy']
+title = 'Title'
+theme = 'Typo'
+
+googleAnalytics = "G-XXXXXXXXX"
+
+
+[params]
+# Math mode
+math = true
+
+# Intro on main page, content in markdown
+homeIntro = true
+homeIntroTitle = 'Hi!'
+homeIntroContent = """
+Here is my blog, this supports markdown: 
+- a
+- b
+- c
+"""
+
+# Collection to display on home
+homeCollectionTitle = 'Posts'
+homeCollection = 'posts'
+
+# Pagination size across all website
+paginationSize = 100
+
+# Social icons
+[[params.social]]
+name = "linkedin"
+url = "https://www.linkedin.com/in/"
+
+[[params.social]]
+name = "medium"
+url = "https://medium.com/"
+
+[[params.social]]
+name = "github"
+url = "https://github.com/"
+
+
+# Main menu pages
+[[params.menu]]
+name = "home"
+url = "/"
+
+[[params.menu]]
+name = "posts"
+url = "/posts"
+
+[[params.menu]]
+name = "about"
+url = "/about"
+
+# Syntax highligth on code blocks
+[markup]
+[markup.highlight]
+style = 'algol'
+```
\ No newline at end of file
diff --git a/assets/css/vars.css b/assets/css/vars.css
index 1ec2afd..5a1ed78 100644
--- a/assets/css/vars.css
+++ b/assets/css/vars.css
@@ -4,7 +4,7 @@
     --main-padding-bottom: 3rem;
 
     /* header settings */
-    --header-top-gap: 1.5rem;
+    --header-top-gap: 2rem;
     --header-bottom-gap: 2rem;
     --header-menu-side-gap: .5rem;
     --header-menu-top-gap: 1rem;