From 525c0011c8d4b6a25cf4094198a6ebd1876d9148 Mon Sep 17 00:00:00 2001
From: Aditya Telange <21258296+adityatelange@users.noreply.github.com>
Date: Fri, 25 Sep 2020 13:18:15 +0530
Subject: [PATCH] README: update with more info and ss
---
README.md | 47 +++++++++++++++++++++++++++++------------------
1 file changed, 29 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 3e2d2753..f0941998 100755
--- a/README.md
+++ b/README.md
@@ -4,48 +4,59 @@
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adityatelange_hugo-PaperMod&metric=alert_status)](https://sonarcloud.io/dashboard?id=adityatelange_hugo-PaperMod)
![code-size](https://img.shields.io/github/languages/code-size/adityatelange/hugo-PaperMod)
-# hugo-PaperMod
-
-A simple, clean, flexible and responsive Hugo theme.
+# hugo-PaperMod | [Demo](https://adityatelange.github.io/hugo-PaperMod/)
☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive
----
+Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper).
-
+The goal of this project is add more Features and customization to the og theme.
+
+The [demo site](https://adityatelange.github.io/hugo-PaperMod/) includes a lot of documentation about Installation, Features with few more stuff. Make sure you visit it, to get the awesome hands-on experience and get known about the features ...
---
-## Overview
-
-Demo Site : https://adityatelange.github.io/hugo-PaperMod/
+
+
+
+
---
## Install
-Read Wiki => [hugo-PaperMod - Installation](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)
+Read this post For More Details => [hugo-PaperMod - Installation](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-installation/)
---
## Features/Mods
-Read Wiki => [hugo-PaperMod - Features](https://github.com/adityatelange/hugo-PaperMod/wiki/Features)
+- Uses Hugo's asset generator with pipelining, fingerprinting, bundling and minification by default.
+- 3 Modes:
+ - Regular Mode.
+ - [Home-Info Mode.](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/#home-info-mode)
+ - [Profile Mode.](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/#profile-mode)
+- Table of Content Generation (newer implementation).
+- Archive of posts
+- Social-Media Share buttons on post.
+- Menu location indicator.
+- Multilingual support.
+- Cover image for each post
+- Light/Dark theme ( automatic theme switch a/c to browser theme)
+- No webpack, nodejs and other depedencies required to edit the theme :)
+
+Read this post For More Details => [hugo-PaperMod - Features](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/)
+
+Release ChangeLog has info about stuff added: [Releases](https://github.com/adityatelange/hugo-PaperMod/releases)
---
### Social-Icons
-Read Wiki => [Social-Icons](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons#social-icons)
+Read this post For More Details => [Social-Icons](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-icons/)
---
-## LightHouse
+## LightHouse Report
-
----
-
-### Credits
-
-Inspired from [hugo-paper](https://github.com/nanxiaobei/hugo-paper) :)