Updated Readme for Port

README.md

@@ -1,36 +1,69 @@
-Astral by HTML5 UP
-html5up.net | @ajlkn
-Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
-
-
-First of its kind on H5U! Astral features a flat, minimalistic design, a fully animated
-interface (with noscript fallbacks), and styling for all basic page elements (including
-blockquotes, tables and lists). Enjoy!
-
-Demo images* courtesy of Unsplash, a radtastic collection of CC0 (public domain) images
-you can use for pretty much whatever.
-
-(* = Not included)
-
-Feedback, bug reports, and comments are not only welcome, but strongly encouraged :)
-
-AJ
-[email protected] | @ajlkn
-
-PS: Not sure how to get that contact form working? Give formspree.io a try (it's awesome).
-
-
-Credits:
-
-	Demo Images:
-		Unsplash (unsplash.com)
-
-	Icons:
-		Font Awesome (fortawesome.github.com/Font-Awesome)
-
-	Other:
-		jQuery (jquery.com)
-		html5shiv.js (@afarkas @jdalton @jon_neal @rem)v
-		background-size polyfill (github.com/louisremi)
-		Repond.js (j.mp/respondjs)
-		Skel (skel.io)
+# Astral Theme for Pico
+Port of HTML5 UP's [Astral][] theme for [PicoCMS][].
+
+> First of its kind on H5U! Astral features a flat, minimalistic design, a fully animated interface (with noscript fallbacks), and styling for all basic page elements (including blockquotes, tables and lists). Enjoy!
+
+## Getting Started
+
+To use this theme:
+
+1. Download the [Latest Release][] on GitHub.
+1. Extract `themes/astral` to your Pico `themes` folder.
+1. Extract `sample-content/index.md` to your `content` folder.
+1. Configure your website using the YAML options in `index.md`
+
+Other sample files, `contact.md` and `gallery.md`, are provided for your reference.  You may use them if you wish, or simply create your own.
+
+Adding the `Gallery` variable to your YAML will create an image gallery at the bottom of your page.  Each item in `Gallery` needs a `url` and `image` variable.
+
+Adding the `Contact` variable to your YAML will create a contact form at the bottom of your page.  The contents of the `Contact` variable will become the `action` attribute of your contact form.
+
+## Issues and Feature Requests
+
+If you have any issues with this port, or would like to request a feature, please create a new [Issue][] on GitHub.
+
+[Astral]: https://html5up.net/astral
+[PicoCMS]: http://picocms.org/
+[Latest Release]: https://github.com/smcdougall/astral-pico/releases
+[Issue]: https://github.com/smcdougall/astral-pico/issues
+
+---
+
+## Original Readme
+
+Astral by HTML5 UP
+html5up.net | @ajlkn
+Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
+
+
+First of its kind on H5U! Astral features a flat, minimalistic design, a fully animated
+interface (with noscript fallbacks), and styling for all basic page elements (including
+blockquotes, tables and lists). Enjoy!
+
+Demo images* courtesy of Unsplash, a radtastic collection of CC0 (public domain) images
+you can use for pretty much whatever.
+
+(* = Not included)
+
+Feedback, bug reports, and comments are not only welcome, but strongly encouraged :)
+
+AJ
+[email protected] | @ajlkn
+
+PS: Not sure how to get that contact form working? Give formspree.io a try (it's awesome).
+
+
+Credits:
+
+  Demo Images:
+    Unsplash (unsplash.com)
+
+  Icons:
+    Font Awesome (fortawesome.github.com/Font-Awesome)
+
+  Other:
+    jQuery (jquery.com)
+    html5shiv.js (@afarkas @jdalton @jon_neal @rem)v
+    background-size polyfill (github.com/louisremi)
+    Repond.js (j.mp/respondjs)
+    Skel (skel.io)