diff --git a/README.md b/README.md index c1a4fee..9c816ee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # grunt-hackmyresume -> Grunt plugin for HackMyResume. +> Grunt plugin for [HackMyResume](https://github.com/hacksalot/HackMyResume). ## Getting Started This plugin requires Grunt `~0.4.5` @@ -24,64 +24,115 @@ In your project's Gruntfile, add a section named `hackmyresume` to the data obje ```js grunt.initConfig({ + + // Run HackMyResume! hackmyresume: { options: { - // Task-specific options go here. - }, - your_target: { - // Target-specific file lists and/or options go here. + theme: 'compact' }, - }, + main: { + src: 'path/to/resume.json', + dest: 'path/to/generated/resume.all' + } + } + }); ``` + ### Options -#### options.separator +The full HackMyResume options model is supported. A few of the more commonly +used options are: + +#### options.theme Type: `String` -Default value: `', '` +Default value: `'modern'` -A string value that is used to do something with whatever. +A string describing the resume theme to use. Can be either: -#### options.punctuation +- The name of a predefined FRESH theme (`modern`, `compact`, `positive`, + `awesome`, or `basis`) +- The path to a locally-installed theme (for ex, + `node_modules/jsonresume-theme-classy`) + +#### options.css +Type: `String` +Default value: `'embed'` + +Whether CSS files should be linked (`link`) or embedded (`embed`) via `` +or `