From 8a89f92b6f105777d3937a08db9d46e7a01f37b0 Mon Sep 17 00:00:00 2001
From: Pablo <7073164+pablods90@users.noreply.github.com>
Date: Tue, 7 May 2024 22:02:23 +0100
Subject: [PATCH] Update README.md

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a1dd38b..faf53ea 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,32 @@
-# Hello Friend NG
+# Hello Friend XT
+
+##  WIP
+*The [original theme](https://github.com/panr/hugo-theme-hello-friend) has been archived. I am working on tweaking and updating this theme. If I manage to get it working, I will revamp the readme so everyone can re-use it.*
+- [How to properly import themes as go modules](https://scripter.co/hugo-modules-importing-a-theme/)
+- Single branches can be created for different websites, in case you need to re-use this theme with small changes
+- I need to bring things from the main project readme, such as:
+### Install theme as Hugo Module
+
+```bash
+# If this is the first time you're using Hugo Modules
+# in your project. You have to initiate your own module before
+# you fetch the theme module.
+# '[your-website-git-url]' is just a placeholder for your module name.
+#
+hugo mod init [your-website-git-url]
+hugo mod get github.com/pablods90/hugo-theme-hello-friend-xt
+```
+
+and in your config file add:
+
+```toml
+[module]
+  # this is needed when you fetch the theme as a submodule to your repo.
+  # replacements = "github.com/pablods90/hugo-theme-hello-friend -> themes/hello-friend"
+[[module.imports]]
+  path = 'github.com/pablods90/hugo-theme-hello-friend'
+```
+***
 
 ![Hello Friend NG](https://dsh.re/d914c)