write docs

1 files changed, 50 insertions, 1 deletions

diff --git a/README.md b/README.md
index 1a1aebe..b39a3a4 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,50 @@
-# WIP
\ No newline at end of file
+# HugoTeX
+
+A hugo theme which looks like a LaTeX document.
+
+![screenshot](images/screenshot.png)
+
+**Live Demo: https://hugotex.netlify.app/**
+
+## Quick Start
+
+```
+git clone https://github.com/7ma7X/HugoTeX
+cd HugoTeX/exampleSite
+hugo server -t ../..
+```
+
+Hugo (>= **0.60.1**) is required.
+
+This theme is heavily inspired by [latex-css](https://github.com.cnpmjs.org/vincentdoerig/latex-css).
+
+## config settings
+
+example
+
+```toml
+baseURL = "https://hugotex.netlify.app/"
+title = "HugoTeX"
+paginate = 3
+languageCode = "en"
+DefaultContentLanguage = "en"
+enableInlineShortcodes = true
+footnoteReturnLinkContents = "^"
+
+[author]
+  name = "Kaito Sugimoto"
+  abstract = "I'm a software engineer and a coffee enthusiast in Japan. My primary interest lies in the area of natural language processing."
+
+[taxonomies]
+category = "categories"
+tag = "tags"
+series = "series"
+```
+
+## For contributors
+
+Any issues or pull requests are welcome.
+
+## LICENSE
+
+MIT
\ No newline at end of file