1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..382de49
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# yapssg
+*yet another pointless static site generator*
+
+A static site generator for embedding Lua in your HTML.
+
+## Usage
+Basic CLI Usage:
+```
+yapssg FILE [-o OUTPUT]
+yapssg -d DIRECTORY [-o OUTPUT] [-f]
+```
+
+See examples for other usage.
+
+## Requirements
+- make
+- pkg-config
+- libxml2
+- luajit
+
+## Installation
+```
+$ git clone https://git.bwaaa.monster/yapssg
+$ cd yapssg
+# make install
+```
+
+## Contribution
+Generate a patch with ```git format-patch HEAD~1``` and email to [gabriel@bwaaa.monster](mailto:gabriel@bwaaa.monster), beginning the subject line with [PATCH yapssg] 
+
+*If you are sending a revised version of a previous patch, please use [PATCH yapssg v2, v3, etc].*