Update README file

auroredea · Mar 7, 2016 · 45f8e64 · 45f8e64
1 parent 68f1a4d
commit 45f8e64
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# YUI Compressor Plugin
+
+A pelican plugin which minify through yui compressor CSS/JS file on building step.
+
+# Installation
+
+In order to work, JRE should be already installed.
+Please add `pip install yuicompressor`
+
+More info : (https://github.com/yui/yuicompressor)
+
+# Instructions
+
+Add `yuicompressor` to `pelicanconf.py` after install :
+`PLUGINS = ['yuicompressor']`
+
+# Licence
+
+GNU AFFERO GENERAL PUBLIC LICENSE Version 3
diff --git a/readme.md b/readme.md