Clean commits

1 files changed, 142 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..a820079e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,142 @@
+## Hugo Iris Theme
+
+<!-- https://shields.io/ -->
+[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/peaceiris/hugo-iris/blob/master/LICENSE)
+
+This repository includes the [Hugo] theme for your presentation.
+
+- Writing slides using Markdown. ([reveal.js])
+- [MathJax] on slides.
+- Diagram and flowchart on slides. ([mermaid])
+
+This theme can manage and publish slides using Hugo.
+
+- [Demo (Netlify)]
+
+
+
+## Table of Contents
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Features](#features)
+  - [MathJax](#mathjax)
+  - [mermaid](#mermaid)
+- [Installation](#installation)
+  - [Download theme](#download-theme)
+- [Hosting](#hosting)
+  - [Netlify](#netlify)
+  - [GitHub Pages](#github-pages)
+- [Special Thanks](#special-thanks)
+- [Author](#author)
+- [Contributing](#contributing)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+
+
+## Features
+
+- [MathJax]: Beautiful math in all browsers.
+- [mermaid]: Generation of diagram and flowchart from text in a similar manner as markdown.
+- [PageSpeed Insights Scores](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fhugoiris.netlify.com%2F): Mobile `96`, Desktop `100`
+
+### MathJax
+
+### mermaid
+
+
+
+## Installation
+
+### Download theme
+
+
+
+## Hosting
+
+### Netlify
+
+<!-- Deploy to Netlify Button -->
+<!-- https://www.netlify.com/docs/deploy-button/ -->
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/peaceiris/hugo-iris)
+
+### GitHub Pages
+
+- [Host on GitHub | Hugo]
+
+The next method is recommended.
+
+- [Deployment of Project Pages From Your gh-pages branch]
+
+
+
+## Special Thanks
+
+- [Hugo]
+- [reveal.js]
+- [MathJax]
+- [mermaid]
+
+
+
+## Author
+
+- peaceiris
+    - [GitHub]
+    - [Twitter]
+
+
+
+## Contributing
+
+To contribute to this hugo theme.
+
+1. Fork this repo locally.
+2. Find or Open [GitHub Issues].
+3. Commit your code on a separate branch.
+4. Send your Pull Request.
+
+You can find more detail in our [Contributing Guide].
+
+Participation in this open source project is subject to a [Code of Conduct].
+
+
+
+## License
+
+This theme is released under the [MIT License].
+
+Copyright © 2019, peaceiris
+
+
+
+---
+
+[:small_red_triangle: Back to TOC]
+
+
+
+<!-- Internal References -->
+[:small_red_triangle: Back to TOC]: #table-of-contents
+
+[Demo (Netlify)]: https://hugoiris.netlify.com/
+[MIT License]: ./LICENSE
+[GitHub Issues]: https://github.com/peaceiris/hugo-iris/issues
+[Contributing Guide]: ./CONTRIBUTING.md
+[Code of Conduct]: ./CODE_OF_CONDUCT.md
+
+[GitHub]: https://github.com/peaceiris
+[Twitter]: https://twitter.com/piris314en
+
+<!-- External References -->
+[Hugo]: https://gohugo.io/
+[reveal.js]: https://github.com/hakimel/reveal.js/
+[MathJax]: https://www.mathjax.org/
+[mermaid]: https://github.com/knsv/mermaid
+
+[Host on GitHub | Hugo]: https://gohugo.io/hosting-and-deployment/hosting-on-github/
+[Deployment of Project Pages From Your gh-pages branch]: https://gohugo.io/hosting-and-deployment/hosting-on-github/#deployment-of-project-pages-from-your-gh-pages-branch