fresh-resume-validator/README.md

The official validator for FRESH resumes.

fresh-resume-validator
===
[![Latest release][img-release]][latest-release]
[![Build status (MASTER)][img-master]][travis-url-master]
[![Build status (DEV)][img-dev]][travis-url-dev]

*Validate résumés and CVs against the [FRESH Resume Schema][frs].*

## Use

### Via the Command Line

The easiest way to use the validator is with [HackMyResume][hmr]'s `validate`
command, which uses `fresh-resume-validator` internally.

1. Install HackMyResume with `npm i -g hackmyresume`.
2. Validate the resume with `hackmyresume validate resume.json`.

### Via the API

You can also validate resumes programatically.

1. Install the `fresh-resume-validator` library.

    ```bash
    npm i fresh-resume-validator --save
    ```

2. Call the `isValid` method.

    ```js
    var validator = require('fresh-resume-validator');
    if ((validator.isValid(myResume)) {
      // do something
    }

    ```

## License

MIT. See [LICENSE.md][lic] for details.

[frs]: https://resume.freshstandard.org
[hmr]: https://github.com/hacksalot/HackMyResume
[lic]: LICENSE.md
[travis-url-master]: https://travis-ci.org/fresh-standard/fresh-resume-validator?branch=master
[travis-url-dev]: https://travis-ci.org/fresh-standard/fresh-resume-validator?branch=dev
[latest-release]: https://github.com/fresh-standard/fresh-resume-validator/releases/latest
[img-release]: https://img.shields.io/github/release/fresh-standard/fresh-resume-validator.svg?label=version
[img-master]: https://img.shields.io/travis/fresh-standard/fresh-resume-validator/master.svg
[img-dev]: https://img.shields.io/travis/fresh-standard/fresh-resume-validator/dev.svg?label=dev