Initial commit

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b6c089
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Paperback
+
+_Paperback_ is a minimalist theme for [Hugo](http://gohugo.io).
+
+It focuses on reading experience, and was mostly designed to suit my needs.
+
+## Parameters
+
+A few parameters can be adjusted in the site config:
+
+```toml
+[params]
+
+# default: undefined
+AuthorName = "Firstname Lastname"
+
+# tagline to show beneath homepage h1
+# default: undefined
+Tagline = "Hello, world!"
+
+# number of posts to show on index; default: 10
+HomepagePosts = 3
+
+# if set to true, social links will be displayed in the footer
+# default: undefined
+SocialLinks = true
+
+# default: undefined
+GithubUsername = "damiencaselli"
+
+# default: undefined
+TwitterUsername = "damiencaselli"
+```