diff --git a/LICENSE.md b/LICENSE.md index 2194070..4cba086 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,7 +1,7 @@ The MIT License =============== -Copyright (c) 2016 Sir Hacksalot (https://github.com/hacksalot) +Copyright (c) 2016 hacksalot (https://github.com/hacksalot) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index f79e583..1fe5775 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,40 @@ fresh-resume-starter ==================== -An starter résumé in [FRESH][f] format. This is the résumé emitted by the -`hackmyresume new` command. +A starter résumé in [FRESH][f] format. This is the résumé emitted by the +[HackMyResume][hmr] `new` command. + +- [**starter-resume.fresh.json**][rf]. The official FRESH-format starter résumé. + +- [**starter-resume.jrs.json**][rj]. The same résumé in JSON Resume 0.0.0 +format. *Note: JSON Resume doesn't support all FRESH resume sections. This +resume contains a subset of the information from the official FRESH version.* + +## Use + +In HackMyResume: + +```bash +hackmyresume new r0.json # Create a FRESH-format resume by default +hackmyresume new r1.json -f FRESH # Create a FRESH-format resume +hackmyresume new r2.json -f JRS # Create a JRS-format resume + +``` + +In code: + +```javascript +var freshStarterResume = require('fresh-resume-starter').fresh; +var jrsStarterResume = require('fresh-resume-starter').jrs; +console.log( freshStarterResume.name ); +// > Slim Shady +``` ## License MIT. See [LICENSE.md][lic] for details. [f]: https://github.com/fluentdesk/FRESCA.git +[hmr]: http://please.hackmyresume.com [lic]: https://github.com/fluentdesk/fresh-resume-empty/blob/master/LICENSE.md +[rf]: https://github.com/fluentdesk/fresh-resume-starter/blob/master/src/starter-resume.fresh.json +[rj]: https://github.com/fluentdesk/fresh-resume-starter/blob/master/src/starter-resume.jrs.json diff --git a/package.json b/package.json index c899889..ccf43c3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "fresh-resume-starter", - "version": "0.2.2", + "version": "0.3.0", "description": "A starter FRESH resume.", "repository": { "type": "git", @@ -21,6 +21,6 @@ "bugs": { "url": "https://github.com/fluentdesk/fresh-resume-starter/issues" }, - "main": "src/starter-resume.fresh.json", + "main": "src/index.js", "homepage": "https://github.com/fluentdesk/fresh-resume-starter" } diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..3f9e658 --- /dev/null +++ b/src/index.js @@ -0,0 +1,17 @@ +/** +Module definition for fresh-resume-starter. +@module fresh-resume-starter +*/ +(function() { + + // Support client-side usage of: + // + // require('fresh-resume-starter').fresh + // require('fresh-resume-starter').jrs + // + module.exports = { + fresh: require('./starter-resume.fresh.json'), + jrs: require('./starter-resume.jrs.json') + }; + +}()); diff --git a/src/starter-resume.jrs.json b/src/starter-resume.jrs.json new file mode 100644 index 0000000..640e4c7 --- /dev/null +++ b/src/starter-resume.jrs.json @@ -0,0 +1,202 @@ +{ + "basics": { + "name": "Your Name", + "label": "Your Profession", + "summary": "A brief description of yourself as a candidate that appears in some résumé themes. You may use **Markdown** and/or HTML formatting here including [links](https://en.wikipedia.org/wiki/Special:Random) or stick to plain text.", + "website": "http://your-website.com", + "phone": "1-999-999-9999", + "email": "your-email@your-website.com", + "picture": "", + "location": { + "address": "123 Somewhere Lane", + "postalCode": "90210", + "city": "Castle Rock", + "countryCode": "US", + "region": "State, province, or region" + }, + "profiles": [ + { + "network": "GitHub", + "username": "your-github-username", + "url": "https://github.com/your-github-username" + } + ] + }, + "work": [ + { + "company": "Most Recent Employer", + "website": "http://employer-website.com", + "position": "Head Honcho", + "startDate": "2013-10", + "summary": "A summary of your role in this position. Can include **Markdown** and inline HTML formatting.", + "highlights": [ + "Increased profits on left-handed spin widgets by 35%.", + "Participated in iterative/incremental devolution.", + "Promoted to Head Ninja after 500 successful cage matches." + ] + }, + { + "company": "Previous Employer", + "website": "http://employer-website.com", + "position": "Worker Bee", + "startDate": "2009-07", + "endDate": "2013-10", + "summary": "A summary of your previous role. Can include **Markdown** and inline HTML formatting.", + "highlights": [ + "Highlight #1.", + "Highlight #2.", + "Highlight #3." + ] + } + ], + "education": [ + { + "institution": "Acme University", + "gpa": "3.5", + "courses": [ + "Data Algorithms", + "Optimization", + "Neural Networks", + "C", + "C++", + "Java", + "HTTP", + "TCP/IP" + ], + "startDate": "2004-09", + "endDate": "2009-06" + } + ], + "skills": [ + { + "name": "Web Development", + "level": "advanced", + "keywords": [ + "LAMP", + "JavaScript", + "HTML 5", + "Angular.js", + "jQuery", + "Sass", + "LESS" + ] + }, + { + "name": "Ninjitsu", + "level": "intermediate", + "keywords": [ + "Tokagure Ryu", + "Shuriken", + "Yogen" + ] + }, + { + "name": "Skillset #3", + "level": "beginner", + "keywords": [ + "Your", + "keywords", + "here" + ] + } + ], + "volunteer": [ + { + "flavor": "volunteer", + "organization": "The Mommies Network", + "position": "Volunteer Coordinator", + "startDate": "2006-06", + "website": "http://themommiesnetwork.org", + "summary": "A summary of your volunteer experience at this organization. Can include **Markdown** and inline HTML formatting.", + "highlights": [] + }, + { + "flavor": "military", + "organization": "Air Force", + "position": "MOS", + "startDate": "2004", + "website": "https://service-website.mil", + "summary": "A summary of your service experience with this organization. Can include **Markdown** and inline HTML formatting.", + "highlights": [] + } + ], + "awards": [ + { + "flavor": "award", + "url": "http://please.hackmyresume.com", + "title": "Awesomeness Award", + "date": "2016", + "awarder": "HackMyResume", + "summary": "Thanks for being a HackMyResume / FluentCV user!" + }, + { + "flavor": "industry", + "title": "MVP: SpinWidget Technology", + "date": "2015-08-03", + "awarder": "Big Software", + "summary": "For work in promotion and popularization of SpinWidget technology." + } + ], + "publications": [ + { + "name": "My Blog", + "publisher": "Medium.com", + "releaseDate": "2010", + "website": "http://coding-snorer.com", + "summary": "Your blog or online home." + }, + { + "name": "Something I Wrote Once", + "publisher": "Acme University Press", + "releaseDate": "2009", + "website": "http://codeproject.com/something-i-wrote-once", + "summary": "List your blogs, articles, essays, novels, and dissertations." + } + ], + "interests": [ + { + "name": "GitHub", + "summary": "Regular GitHub user and tinkerer.", + "keywords": [ + "GitHub", + "git", + "GitHub Desktop (OS X)", + "LFS", + "GitHub API" + ] + }, + { + "name": "chess", + "summary": "Avid chess player.", + "keywords": [ + "Sicilian", + "King's Gambit", + "Ruy Lopez" + ] + } + ], + "references": [ + { + "name": "John Doe", + "reference": "Such-and-such is awesome! I'd hire him/her again in a second!" + }, + { + "name": "Somebody Important", + "reference": "Hands-down *the best developer/manager/spelunker/coworker/etc* I've ever worked with. Emphasis *mine!*" + } + ], + "languages": [ + { + "language": "English", + "level": "native" + }, + { + "language": "Spanish", + "level": "advanced" + }, + { + "language": "C++", + "level": "intermediate" + } + ] +} \ No newline at end of file