Fork us on GitHub

Notice: Hey everybody, this project went viral today even though it's a work in progress. We would love if everybody leaves Github issues for things they think are wrong or need work in the specification draft.

Overview

Json Résumé. is a community driven open source initiative to create a JSON based standard for résumés. There is no reason why there can't be a common standard for writing a résumé that can be extended with an ecosystem of open source tools. This project will attempt to;

  • Build a community open source movement where everyone can take advantage of the tools
  • Make themeing, exporting, storing and editing résumés super easy

Join us on IRC - #jsonresume - Freenode

Why JSON?

We feel that JSON Schema is now mature enough for writing usable schematics. YAML doesn't throughly offer schematic standards yet(though you can easily convert your résumé between YAML and JSON anyway).

Versioning

We will generally do 2 year cycles of revisions to the specification. Though upon release the lifecycle will be short for 3 months whilst last minute revisions are made to the standard

Open Source

Everything on the jsonresume.org domain name is opened source under a MIT license. This is meant to be a community effort to better the JSON résumé ecosystem.


Getting Started

We have built a CLI(command line interface) which currently is supported on OS/Linux/Windows via NPM. To start creating your own résumé, install the resume-cli via NPM.

sudo npm install -g resume-cli

Excellent! Now initialize your first resume.js

resume init

Exporting

The command line tool, uses an ecosytem of modules we have open sourced to convert your résumé.

resume export [myFileName] --format html

resume export [myFileName] --format pdf --theme flat

Or to be guided through the export options just type;

resume export

Publishing

We have also built in hosted support into the command line app. Much like NPM's registry, you can register an account and publish to our servers. We also allow you to password protect and/or publish your résumé anonymously. To get started simply type;

resume publish

Our hosted solution will have new features and benefits rolled out quite frequently. Make sure you register if you want to save a vanity url.

resume register

Great! You should now have your own url like;
http://registry.jsonresume.org/thomasdavis

You can also access exported versions of your résumé;
http://registry.jsonresume.org/thomasdavis.pdf (still ugly)
http://registry.jsonresume.org/thomasdavis.txt

Users may also password protect their résumé;
http://registry.jsonresume.org/richardhendriks

Themes

Our themeing system is still in development for now you can get a preview of them;
http://registry.jsonresume.org/thomasdavis?theme=modern
http://registry.jsonresume.org/thomasdavis?theme=flat

Update:
We changed the theme system so themes are just starting to be developed. Check back tomorrow or create a theme.

Internationalization

The specification draft was started by Australian's so you will have to forgive our ignorance of the northern hermisphere. If you see any glaringly obvious problems with international properties, create an issue


Contributing

As mentioned above, the entire project is open sourced and split up amongst a number of modules which are hosted on Github. There are many areas of the project that need work

  • We need anyone and everyone to start making themes
  • People who can offer advice on the standard
  • The standard should be able to export to any format under the sun
  • We want to create a standards board and also a public list of contributions to the specification.

All the code for the project can be found on our Github organization;
https://github.com/jsonresume

Team

The project was started in late June by Thomas Davis and Roland Sharp.

Examples

64x64 64x64

Specification

The latest published draft is unversioned and is currently wanting feedback. We want to release a version 1.0.0 in late July that locks the standard down for at least a year.

{
bio: {
firstName: string,
lastName: string,
email: {
work: string, // e.g. [email protected]
personal: string // [email protected]
},
phone: { // Phone numbers are stored as strings so use any format you like
work: string, // e.g. 732-757-2923
personal: string // e.g. 712-117-2923
},
summary: string, // Write a short 2-3 sentence biography about yourself
location: {
city: string,
countryCode: string, // e.g. US, AU, IN
region: string, // If you specify a region, you don't need a state e.g. Queensland
state: string // If you specify a state, you don't need a region e.g. Texas
},
websites: { // The value you use as your key, will generally become the label
blog: string // e.g. http://blog.joebloggs.com
},
profiles: { // Specify any number of social networks that you participate in
twitter: string, // e.g. neutralthoughts
github: string // e.g. thomasdavis
}
},
work: [{
company: string, // e.g. Facebook
position: string, // e.g. Software Engineer
website: string, // e.g. http://facebook.com
startDate: string, // resume.json uses the ISO 8601 date standard e.g. 2014-06-29
endDate: string, // e.g. 2012-06-29
summary: string, // Give an overview of your responsibilities at the company
highlights: [ // Specify multiple accomplishments
string // e.g. Increased profits by 20% from 2011-2012 through viral advertising
]
}],
education: [{
institution: string, // e.g. Massachusetts Institute of Technology
area: string, // e.g. Arts
studyType: string, // e.g. Bachelor
startDate: string, // e.g. 2014-06-29
endDate: string, // e.g. 2012-06-29
courses: [ // List an notable courses/subjects
string // e.g. H1302 - Introduction to American history
]
}],
awards: [{ // Specify any awards you have received throughout your professional career
title: string, // e.g. One of the 100 greatest minds of the century
awardDate: string, // e.g. 1989-06-12
awarder: string // e.g. Time Magazine
}],
publications: [{ // Specify your publications through your career
name: string, // e.g. The World Wide Web
publisher: string, // e.g. IEEE, Computer Magazine
releaseDate: string, // e.g. 1990-08-01
website: string // e.g. http://www.computer.org/csdl/mags/co/1996/10/rx069-abs.html
}],
skills: [{ // List out your professional skill-set
name: string, // e.g. Web Development
level: string, // e.g. Master
keywords: [ // List some keywords pertaining to this skill
string // e.g. HTML
]
}],
hobbies: [{
name: string, // e.g. Philosophy
keywords: [
string // e.g. Friedrich Nietzsche
]
}],
references: [{ // List references you have received
name: string, // e.g. Timothy Cook
reference: string // e.g. Joe blogs was a great employee, who turned up to work at least once a week. He exceeded my expectations when it came to doing nothing.
}]
}