updated README
authorMatthewOwens <matthew@owens.tech>
Thu, 16 Jul 2020 15:27:10 +0000 (16:27 +0100)
committerMatthewOwens <matthew@owens.tech>
Thu, 16 Jul 2020 15:27:10 +0000 (16:27 +0100)
README.md

index 30ac044..0481cdc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,19 @@
-# static website generation with githooks
+# static website generation with githooks and markdown
 
-## posts/
+## why?
+previously my website was hosted on GitHub pages using Jekyll. I found this to
+be really cumbersome to use, hated relying on themes and hated the slew of
+dependencies needed to get it working.
+
+I'm using [discount](https://github.com/Orc/discount) to generate the markdown
+for the pages, until I roll my own markdown implementation. I don't like using
+that either, but it beats Jekyll
+
+### dependencies
+* [discount](https://github.com/Orc/discount)
+
+### posts/
 location of the posts on the website
 
-## scripts/
+### scripts/
 collection of scripts called by the server-side git hooks