Adds README file

1 files changed, 22 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b21da87
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Portfolio static site generator
+
+Uses [Hakyll](https://hackage.haskell.org/package/hakyll) to compile static
+HTML website from markdown source.
+
+Visit my portfolio site [here](https://pauloliver.dev).
+
+## Build
+```console
+$> stack build
+$> stack exec site -- build
+```
+
+## Run local server
+```console
+$> stack exec site -- watch
+```
+
+## Deploy
+```console
+$> rsync -rv _site/ ${dst}
+```