Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/aanupam23/hugo-sugoi.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoraanupam23 <11939280+aanupam23@users.noreply.github.com>2020-04-23 19:12:15 +0300
committeraanupam23 <11939280+aanupam23@users.noreply.github.com>2020-04-23 19:12:15 +0300
commitcd776d19fc51ad250eb11550318312a410121184 (patch)
treeaeb739fc28e17d73cf894599f4d6b1063cd255e4 /README.md
parent86f2f2d47402cde4f4d0d9adbfc0c6a3b35de65c (diff)
Added Readme, theme.toml, templates and design components
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 35 insertions, 5 deletions
diff --git a/README.md b/README.md
index 90656ec..6b25d0d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,36 @@
-# Sugoi
+# Sugoi - An Ultra Minimal Hugo Theme
-- Landing Page
-- Custom Icon for category
-- Read time on blog page
-- Social Sharing \ No newline at end of file
+Hugo-Sugoi is ultra minimal theme built for personal blogs and can be used for learning hugo theme designing. Feel free to use this theme for creating an awesome hugo theme.
+Sugoi theme is bare-bones(literally since it is built on *Skeleton*) and the theme is javascript free.
+
+[Demo Link](https://github.com/aanupam23/hugo-sugoi)
+
+### Features
+- Built on Skeleton and javascript free
+- Consist of custom.css
+- Clean Landing Page with latest blog posts
+- Custom Icons for category
+- Read time on index page and articles
+- Font Awesome icons
+- Toggle based hamburger menu that doesn't require javascript
+
+Also supports Hugo internal templates for
+- Google Analytics
+- Disqus Integration
+
+> Sugoi theme contains blog, single page, contact page, 404 page template.
+
+
+### Installation
+
+Inside the folder of your Hugo site run:
+```
+$ git submodule add https://github.com/aanupam23/hugo-sugoi.git themes/hugo-sugoi
+```
+
+### Licence
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/aanupam23/hugo-sugoi/blob/master/LICENSE)
+
+### Acknowledgements
+- [Skeleton](https://github.com/dhg/Skeleton/)
+- [Hugo Templates](https://gohugo.io/templates) \ No newline at end of file