feat: add readme

2022-01-29 18:07:39 +01:00 · 2022-01-29 18:07:39 +01:00 · aaffd5e682
parent 1061f1dad6
commit aaffd5e682
1 changed files with 18 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,18 @@
+# Vikunja Theme
+
+[![Build Status](https://drone.kolaente.de/api/badges/vikunja/theme/status.svg)](https://drone.kolaente.de/vikunja/theme)
+
+This repo provides the [hugo](https://gohugo.io) theme for the [vikunj.io](https://vikunj.io) website, docs and blog.
+
+## Building
+
+You need nodejs 16 and yarn v1.
+
+```bash
+yarn # install all dependencies
+yarn prod
+yarn clean
+yarn release
+```
+
+Will give you the theme in a tar file in the `dist/` folder.