Add README

vormwald · Aug 10, 2015 · 5b0cae5 · 5b0cae5
1 parent ddf317e
commit 5b0cae5
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+# Joon: Roon theme for Jekyll
+
+Jekyll theme based on the Roon for [Ghost](http://github.com/tryghost/roon/).
+
+## Demo
+View this jekyll theme in action [here](https://vormwald.github.io/joon)
+
+## Screenshot
+![screenshot](https://raw.githubusercontent.com/vormwald/joon/master/screenshot.png)
+
+## Font Options
+
+This theme comes with two font options; a serif and sans-serif (the default). 
+Switching between them is done in the HTML, by adding `serif` to the `class` of 
+the `<body>` element in [head.html](https://github.com/vormwald/joon/blob/master/_layouts/default.html.hbs#L6).
+
+## Colour Options
+
+This theme uses an accent colour for links and the border at the top of pages.
+
+To change this colour, you need to edit [assets/css/screen.css](https://github.com/vormwald/joon/blob/master/assets/css/screen.css).
+
+There are only two values you need to change, conveniently **located at the very
+top of the file**.
+
+## For More Information
+For more on Jekyll, read the [documentation](http://jekyllrb.com/)
+
+
+## Copyright & License
+
+Roon is Copyright (c) 2013-2015 Sam Soffes & Ghost Foundation - Released under 
+the [MIT license](LICENSE).
diff --git a/screenshot.png b/screenshot.png