feat: update readme

1 files changed, 103 insertions, 12 deletions

diff --git a/README.md b/README.md
index 201805d..54a9b9f 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,9 @@
----
-title: Bodhi - Hugo Theme
-layout: article
-summary: Bodhi is a simple, minimal, personal website theme for Hugo.
----
+# Bodhi - Hugo Theme
 
 Bodhi is a simple, minimal, personal website theme for Hugo.
 
+[Demo](https://rohanverma.net/projects/bodhi) [Github](https://github.com/rhnvrm/bodhi)
+
 ## Features
 
 - Google and Fathom Analytics integration
@@ -24,36 +22,129 @@ Bodhi is a simple, minimal, personal website theme for Hugo.
   - Posts (for blogs)
   - Articles (for pages)
 
+## Get Started
+
+### Clone as submodule in your hugo site
+
+```
+git submodule add https://github.com/rhnvrm/bodhi themes/bodhi
+```
+
+### Sample Config
+
+Update your hugo config.toml
+
+You can use the following sample config file:
+
+```toml
+baseURL = "https://rohanverma.net/"
+languageCode = "en-us"
+title = "Rohan Verma"
+theme = "bodhi"
+googleAnalytics = "xxxx"
+
+[params]
+    subtitle = "(rhnvrm)"
+    avatar = "/images/avatar.jpg"
+    author = "Rohan Verma"
+    commentoSrc = "https://commento.myselfhostedinstance.net/js/commento.js"
+    footerMessage = "Feel free to use the content of this website with approripate attribution to the author."
+
+[[menu.main_left]]
+name = "home"
+url = "/"
+weight = 1
+
+[[menu.main_right]]
+name = "contact"
+url = "/contact/"
+weight = 1
+
+[[menu.nav]]
+name = "projects"
+url = "/projects"
+weight = 2
+
+[[menu.nav]]
+parent = "projects"
+name = "bodhi"
+url = "/projects/bodhi"
+weight = 1
+
+[[menu.nav]]
+name = "blogs"
+url = "/blog"
+weight = 1
+
+[[menu.nav]]
+parent = "blogs"
+name = "archive"
+url = "/archive"
+weight = 1
+
+[[menu.nav]]
+parent = "blogs"
+name = "tags"
+url = "/tags"
+weight = 2
+
+[[menu.nav]]
+parent = "blogs"
+name = "categories"
+url = "/categories"
+weight = 3
+
+[markup.goldmark.renderer]
+unsafe= true
+
+[outputs]
+  home = ["HTML", "RSS", "JSON"]
+
+[params.fathomAnalytics]
+    siteID = "XXXXX"
+    serverURL = "https://fathom.myselfhostedinstance.net"
+
+[markup]
+  [markup.highlight]
+    codeFences = true
+    guessSyntax = true
+    lineNoStart = 1
+    noClasses = true
+    style = "emacs"
+    tabWidth = 4
+
+```
+
 ## Previews
 
 ### Home Page
 
-![preview](preview.png)
+![preview](https://rohanverma.net/projects/bodhi/preview.png)
 
 ### Archive Page
 
-![archive page](blog_archive.png)
+![archive page](https://rohanverma.net/projects/bodhi/blog_archive.png)
 
 ### Inbuilt Search
 
-![search page](search.png)
+![search page](https://rohanverma.net/projects/bodhi/search.png)
 
 ### Syntax Highlighting
 
-![syntax](syntax.png)
+![syntax](https://rohanverma.net/projects/bodhi/syntax.png)
 
 ### Minimal Blog Metadata
 
-![blog](blog.png)
+![blog](https://rohanverma.net/projects/bodhi/blog.png)
 
 ### Simple but Responsive
 
-![responsive](responsive.png)
+![responsive](https://rohanverma.net/projects/bodhi/responsive.png)
 
 ## Inspiration
 
 ## suckless
 
-![suckless](suckless.png)
+![suckless](https://rohanverma.net/projects/bodhi/suckless.png)
 
 [suckless](https://suckless.org) is known for their focus on simplicity and clarity. Their website is a good example of simple website design. I really liked how they use the two-column design as a mini-sitemap. This tree layout, is something that is familiar and intuitive to a lot of people. This inspired me to build [Bodhi](/projects/bodhi) to have a two-column layout with the column showing a tree like column on the left.