/fresh-jrs-converter

Convert résumés / CVs between FRESH and JSON Resume formats.

Primary LanguageJavaScriptMIT LicenseMIT

fresh-jrs-converter

Latest release Build status (MASTER)

Convert résumés and CVs between FRESH Résumé Schema and JSON Résumé.

Use

Command Line

The easiest way to use the converter is to install HackMyResume and run the CONVERT command.

hackmyresume convert resume.json converted-resume.json

API

To use the module in code, first install the fresh-jrs-converter module via NPM.

npm i fresh-jrs-converter --save

Then call the toFRESH or toJRS method:

var converter = require('fresh-jrs-converter');
var resume = { /* A FRESH or JSON Resume object */ };

// Convert to FRESH
var freshResume = converter.toFRESH( resume );

// Convert to JSON Resume
var jrsResume = converter.toJRS( resume, opts );

That's it!

Preliminary JSON Resume 1.0.0 support

When converting a resume from FRESH to JSON Resume, set the edge option to true to emit resume properties, like projects and meta, that appear in the latest 1.0.0 candidate version of the JSON Resume schema but which are missing from the latest official 0.16.0 NPM release.

// Convert to JSON Resume
var jrsResume = converter.toJRS( resume, { edge: true } );

When converting from JSON Resume to FRESH, this consideration doesn't apply because the FRESH schema provides an equivalent representation of all JSON Resume sections, collections, and properties.

License

MIT. See LICENSE.txt for details.