From 3ff2c0ccac34e3df2b5c801f94abed2a3c45307d Mon Sep 17 00:00:00 2001
From: Wang Chucheng <ccwangchn@gmail.com>
Date: Sun, 17 May 2020 22:58:10 +0800
Subject: style: brand new index.html

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 44 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8949bc1..118c7a7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,44 @@
-# hugo-eureka
-Eureka is a theme for Hugo.
+# Hugo Eureka
+
+Eureka is a elegant and powerful theme for [Hugo](https://gohugo.io/). Eureka is committed to providing an elegant, feature-rich and highly customizable theme.
+
+## Get Started
+
+### Prerequisites
+
+-   [Git](https://git-scm.com/)
+-   [Hugo Extended v0.65.0+](https://gohugo.io/getting-started/installing/)
+
+Eureka uses [Hugo Pipes](https://gohugo.io/hugo-pipes/introduction/) to process PostCSS, so customizing assets in Eureka requires an extended version of Hugo. If you are new to Hugo, you can read Hugo's [quick start](https://gohugo.io/getting-started/quick-start/).
+
+### Installation
+
+```shell
+cd your_hugo_site
+git init
+git submodule add https://github.com/wangchucheng/hugo-eureka.git themes/eureka
+```
+
+Then, add the theme to the site configuration.
+
+```
+theme = "eureka"
+```
+
+## Usage
+
+Copy the `config.toml` in Eureka's `exampleSite` folder to the root folder of your Hugo site. Feel free to change it.
+
+Then you can add some content in your blog:
+
+```shell
+hugo new post/hello-world.md
+```
+
+After that, you can preview it in the browser:
+
+```shell
+hugo server
+```
+
+For more usage, please refer to Hugo's [basic usage](https://gohugo.io/getting-started/usage/).
-- 
cgit v1.2.3