lyonsinbeta / resume-schema

JSON-Schema is used here to define and validate our proposed resume json

Home Page:http://jsonresume.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

JSON Resume Schema

Build Status

Standard, Specification, Schema

We are still currently un-versioned, some core changes are being pushed out, and then a version 0.0.0 will be released following SemVer.org best practises. We will be experimenting with a migration.js system, each change below will be represented with a function that can update an older version of resume.json to the newer versions.

Change Log

IRC

Everyone working on the early stages of the project should join our Freenode channel

#jsonresume on freenode

You can use the web client http://webchat.freenode.net/

Getting Started

npm install --save resume-schema

To use

var resumeSchema  = require('resume-schema');
resumeSchema.validate({name: "Thomas"});

More likely


var fs = require('fs');
var resumeSchema  = require('resume-schema');
var resumeObject = JSON.parse(fs.readFileSync('resume.json', 'utf8'));
resumeSchema.validate(resumeObject);

People

  • Julian Shapiro for early prototype revisions

Contribute

We encourage anyone who's interested in participating in the formation of this standard, to join us on IRC, and/or to join the discussions here on GitHub. Also feel free to fork this project and submit new ideas that you feel are a needed addition to the jsonresume standard. To make sure all formatting is kept in check, please install the EditorConfig plugin for your editor of choice.

Versioning

JSON Resume Schema adheres to Semantic Versioning 2.0.0. If there is a violation of this scheme, report it as a bug. Specifically, if a patch or minor version is released and breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility. Any change that breaks the public API will only be introduced at a major-version release. As a result of this policy, you can (and should) specify any dependency on JSON Resume Schema by using the Pessimistic Version Constraint with two digits of precision.

Research

Proposals to reinvestigate

Other Resume Standards

About

JSON-Schema is used here to define and validate our proposed resume json

http://jsonresume.org

License:MIT License