From a9d9e802bf0a3e178466e4b56757b9459dca1378 Mon Sep 17 00:00:00 2001
From: Wood <34589275+hfge@users.noreply.github.com>
Date: Sun, 10 Jan 2021 17:47:30 +0800
Subject: [PATCH] Create README.md

---
 README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c16389d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+![Stack](https://i.imgur.com/cCiHOGS.jpg)
+# Hugo Theme Stack
+
+> Card-style Hugo theme designed for bloggers.
+
+## Demo
+
+[Example Site](https://theme-stack.jimmycai.com/)
+
+[![Netlify Status](https://api.netlify.com/api/v1/badges/a2d2807a-a905-4bcb-97da-8da8d847da3d/deploy-status)](https://app.netlify.com/sites/hugo-theme-stack/deploys)
+
+## Documentation & more information
+
+[Documentation](https://docs.stack.jimmycai.com/) | [中文文档](https://docs.stack.jimmycai.com/v/zh-cn/)
+
+## Introduction
+
+Stack is a simple card-style Hugo theme designed for bloggers, some of its features are:
+
+- Responsive images support
+- Lazy load images
+- Dark mode
+- Local search
+- [PhotoSwipe](https://photoswipe.com/) integration
+- Archive page template
+- Full native JavaScript, no jQuery or any other frameworks are used
+- No CSS framework, keep it simple and minimal
+- Properly cropped thumbnails
+- Subsection support
+
+## Requirements
+
+It's necessary to use **Hugo ≥ 0.78.0**.
+
+Use Hugo Extended version (recommended) if you want to:
+
+* Use the latest feature/fix from `master` branch
+* Edit SCSS files
+  
+**Compiled CSS are updated once per release.**
+
+## Installation
+
+Clone / Download this repository to `theme` folder, and edit your site config following `exampleSite/config.toml`.
+
+Check [documentation](https://docs.stack.jimmycai.com/) for more details.
+
+## Copyright
+
+**Licensed under the GNU General Public License v3.0**
+
+Please do not remove the "*Theme Stack designed by Jimmy*" text and link.
+
+If you want to port this theme to another blogging platform, please let me know🙏.
+
+## Sponsoring
+
+If you like this theme, give it a star, and consider supporting its development:
+
+[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C530AXX)
+
+Your support is greatly appreciated :)
+
+## Thanks to
+
+  - [Vibrant-Colors/node-vibrant](https://github.com/Vibrant-Colors/node-vibrant)
+  - [Normalize.css](https://necolas.github.io/normalize.css/)
+  - [Tabler icons](https://tablericons.com/)
+  - [Pure CSS implementation of Google Photos / 500px image layout](https://github.com/xieranmaya/blog/issues/6)
+  - [jonsuh/hamburgers](https://github.com/jonsuh/hamburgers)
+  - [PhotoSwipe](https://photoswipe.com/)
+  - [artchen/hexo-theme-element](https://github.com/artchen/hexo-theme-element)
+  - [MunifTanjim/minimo](https://github.com/MunifTanjim/minimo)
+  - [lepture/yue.css](https://github.com/lepture/yue.css)
+  - Markdown gallery syntax from [Typlog](https://typlog.com/)