diff --git a/README.md b/README.md index f10e186c..1f8fc711 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,18 @@ Requires [Jekyll](https://github.com/mojombo/jekyll) * run jekyll * output will be in \_site/ +## Advanced Usage + +### Alerts + +You can easily put alerts on the homepage by changing the ALERT and ALERT\_CLASS variables in index.html. + +Example: + +``` +ALERT_CLASS: error +ALERT: Security alert: Please upgrade to 0.3.25 as soon as possible! +``` + + +will produce a red alert box. Possible classes are: error (red), info (blue), success (green) and warning (yellow) diff --git a/index.html b/index.html index 70e4c5ac..b7bac62f 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,7 @@ --- DOWNLOAD_VERSION: 0.3.24 +ALERT_CLASS: +ALERT: --- @@ -50,7 +52,11 @@ DOWNLOAD_VERSION: 0.3.24