diff --git a/README.md b/README.md index a345b61..eeb26a5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # fresh-theme-bootstrap -Responsive resume theme using Bootstrap and Bootswatch. +Responsive resume theme for [HackMyResume|https://github.com/hacksalot/HackMyResume] using [Bootstrap|http://getbootstrap.com] and [Bootswatch|https://bootswatch.com]. + +## Install + +Install the latest version with NPM: + +```bash +npm install fresh-theme-bootstrap +``` + +Then specify the theme and css attribute when running HackMyResume: + + +```bash +hackmyresume BUILD resume.json TO out/resume.all --theme node_modules/fresh-theme-bootstrap --css +``` + +The swatch name can be either 'bootstrap' for default Bootstrap look and feel or name of any Bootswatch theme (lumen, darkly, readable ...) + +## Examples