HackMyAPI

The open library for HackMyResume and FluentCV.

Resume and career management reusables for HackMyResume, FluentCV, and [Your Tool Here].

All HackMyResume-related code that isn't directly involved with the CLI lives here. Every important function and class is exported via CommonJS / Node.js module.exports with UMD support forthcoming.

Install

Install the latest stable release with NPM:

npm install hackmyapi --save

Install the latest dev version with NPM using this syntax:

npm install hacksalot/hackmyapi#dev --save

Or, clone from GitHub as usual (take a fork first):

git clone https://github.com/your-name/hackmyapi.git

Use

For convenience, all classes and methods are exposed as properties off of the module object:

// Get the API facade (for convenience)
// You can also require individual components
// with require('hackmyapi/path/to/thing')
var HMR = require('hackmyapi');

// Create and open FRESHResume
var rezA = new HMR.FRESHResume();
rezA.open( 'path/to/resume.json' );

// Create and open a JRSResume
var rezB = new HMR.FRESHResume();
rezB.open( 'path/to/resume.json' );

// Create and invoke an instance of the HMR "build" verb
var build = new HMR.verbs.build({ });
build.invoke(['r1.json', 'r2.json'], ['out/resume.all'], { })l;

// Use other classes and methods on the HMR facade as needed.

You can also import individual classes like so:

var FRESHResume = require('hackmyapi/src/[some-file]');

License

MIT. See LICENSE.md for details.