From 538cb07a5f79c87d3e623b35475cb8ac0d0f7cc9 Mon Sep 17 00:00:00 2001
From: welpo <welpo@users.noreply.github.com>
Date: Sun, 16 Apr 2023 14:52:44 +0200
Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=93=9D=20docs:=20clarify=20installati?=
 =?UTF-8?q?on=20instructions?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5580d1a..705ae0b 100644
--- a/README.md
+++ b/README.md
@@ -34,9 +34,64 @@ See the project's roadmap [here](https://github.com/users/welpo/projects/1).
 git clone git@github.com:welpo/tabi.git
 cd tabi
 zola serve
-# open http://127.0.0.1:1111/ in the browser
 ```
 
+Open http://127.0.0.1:1111/ in the browser.
+
+## Installation
+
+To add tabi to you existing Zola site:
+
+1. Add the theme as a git submodule:
+
+```
+git submodule add https://github.com/welpo/tabi.git themes/tabi
+```
+
+Or clone the theme into your themes directory:
+
+```
+git clone https://github.com/welpo/tabi.git themes/tabi`
+```
+
+2. Enable the theme in your `config.toml`:
+
+```
+theme = "tabi"`
+```
+
+3. Set a `title` in your `config.toml`:
+
+```
+title = "Your Site Title"
+```
+
+4. Create a `content/_index.md` file with the following content:
+
+```
++++
+title = "Home"
+paginate_by = 5 # Set the number of posts per page
+template = "index.html"
++++
+```
+
+If you want to serve your blog posts from a different path, such as `blog/`, add a `section_path` in the `[extra]` section of `content/_index.md` (this file will need pagination):
+
+```
+[extra]
+section_path = "blog/_index.md"
+```
+
+5. If you want an intro page (see screenshot above), add these lines to `content/_index.md`:
+
+```
+[extra]
+header = {title = "Hello! I'm tabi~", img = "$BASE_URL/img/main.webp" }
+```
+
+The content outside the front matter will be rendered between the header title and the posts listing. In the screenshot above, it's the text that reads "Tabi is a fast, lightweight, and modern Zola theme…".
+
 ## Inspiration
 
 This theme was inspired by:

From 73811bdb7aa251620850537fc8126d8a483462e9 Mon Sep 17 00:00:00 2001
From: welpo <welpo@users.noreply.github.com>
Date: Sun, 16 Apr 2023 16:34:12 +0200
Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=93=9D=20docs:=20minor=20changes=20to?=
 =?UTF-8?q?=20installation=20instructions?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 705ae0b..a3cd49b 100644
--- a/README.md
+++ b/README.md
@@ -31,7 +31,7 @@ See the project's roadmap [here](https://github.com/users/welpo/projects/1).
 ## Quick start
 
 ```bash
-git clone git@github.com:welpo/tabi.git
+git clone https://github.com/welpo/tabi.git
 cd tabi
 zola serve
 ```
@@ -42,6 +42,12 @@ Open http://127.0.0.1:1111/ in the browser.
 
 To add tabi to you existing Zola site:
 
+0. Initialize a Git repository in your project directory (if you haven't already):
+
+```
+git init
+```
+
 1. Add the theme as a git submodule:
 
 ```
@@ -51,13 +57,15 @@ git submodule add https://github.com/welpo/tabi.git themes/tabi
 Or clone the theme into your themes directory:
 
 ```
-git clone https://github.com/welpo/tabi.git themes/tabi`
+git clone https://github.com/welpo/tabi.git themes/tabi
 ```
 
+### Required configuration
+
 2. Enable the theme in your `config.toml`:
 
 ```
-theme = "tabi"`
+theme = "tabi"
 ```
 
 3. Set a `title` in your `config.toml`:
@@ -83,7 +91,7 @@ If you want to serve your blog posts from a different path, such as `blog/`, add
 section_path = "blog/_index.md"
 ```
 
-5. If you want an intro page (see screenshot above), add these lines to `content/_index.md`:
+5. If you want an introduction section (see screenshot above), add these lines to `content/_index.md`:
 
 ```
 [extra]