Skip to content

Commit 7ef8558

Browse files
committed
feat!: First release of v1.0.0. The ecosystem still requires updating which will follow in the next few days^Cfter this commit. Thanks to for everybody involved! It has been a solid community effort
1 parent 94a1899 commit 7ef8558

File tree

1 file changed

+28
-32
lines changed

1 file changed

+28
-32
lines changed

README.md

Lines changed: 28 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@
77

88
Standard, Specification, Schema
99

10-
### Gitter
11-
12-
Everyone working on the early stages of the project should join our gitter channel [gitter.im/jsonresume/public](https://gitter.im/jsonresume/public).
13-
1410
### Getting started
1511

1612
```
@@ -20,40 +16,40 @@ npm install --save resume-schema
2016
To use
2117

2218
```js
23-
var resumeSchema = require('resume-schema');
24-
resumeSchema.validate({ name: "Thomas" }, function (err, report) {
25-
if (err) {
26-
console.error('The resume was invalid:', err);
27-
return;
19+
const resumeSchema = require("resume-schema");
20+
resumeSchema.validate(
21+
{ name: "Thomas" },
22+
function (err, report) {
23+
if (err) {
24+
console.error("The resume was invalid:", err);
25+
return;
26+
}
27+
console.log("Resume validated successfully:", report);
28+
},
29+
function (err) {
30+
console.error("The resume was invalid:", err);
2831
}
29-
console.log('Resume validated successfully:', report);
30-
}, function(err) {
31-
console.error('The resume was invalid:', err);
32-
});
32+
);
3333
```
3434

3535
More likely
3636

3737
```js
38-
var fs = require('fs');
39-
var resumeSchema = require('resume-schema');
40-
var resumeObject = JSON.parse(fs.readFileSync('resume.json', 'utf8'));
38+
var fs = require("fs");
39+
var resumeSchema = require("resume-schema");
40+
var resumeObject = JSON.parse(fs.readFileSync("resume.json", "utf8"));
4141
resumeSchema.validate(resumeObject);
4242
```
4343

4444
The JSON Resume schema is available from:
4545

4646
```js
47-
require('resume-schema').schema;
47+
require("resume-schema").schema;
4848
```
4949

50-
### People
51-
52-
* Julian Shapiro for early prototype revisions
53-
5450
### Contribute
5551

56-
We encourage anyone who's interested in participating in the formation of this standard, to join us on Gitter, and/or to join the discussions [here on GitHub](https://github.com/jsonresume/resume-schema/issues). Also feel free to fork this project and submit new ideas to add to the JSON Resume Schema standard. To make sure all formatting is kept in check, please install the [EditorConfig plugin](http://editorconfig.org/) for your editor of choice.
52+
We encourage anyone who's interested in participating in the formation of this standard to join the discussions [here on GitHub](https://github.com/jsonresume/resume-schema/issues). Also feel free to fork this project and submit new ideas to add to the JSON Resume Schema standard. To make sure all formatting is kept in check, please install the [EditorConfig plugin](http://editorconfig.org/) for your editor of choice.
5753

5854
### Versioning
5955

@@ -66,17 +62,17 @@ a major-version release. As a result of this policy, you can (and should)
6662
specify any dependency on JSON Resume Schema by using the Pessimistic Version
6763
Constraint with two digits of precision.
6864

69-
### Research
65+
We use automatic semver system.
7066

71-
- [A more professional recruitment process with structured data](/research/A%20more%20professional%20recruitment%20process%20with%20structured%20CV%20data.pdf).
67+
Pull requests titles should be formatted as such
7268

73-
### Proposals to reinvestigate
74-
75-
* [#69 - Standard format for phone numbers](https://github.com/jsonresume/resume-schema/issues/69)
76-
* [#44 - Person-Job Fit ](https://github.com/jsonresume/resume-schema/issues/44)
77-
* [#12 - geotag location in work ](https://github.com/jsonresume/resume-schema/issues/12)
78-
* [#51 - Support multiple positions within one job](https://github.com/jsonresume/resume-schema/issues/51)
69+
```
70+
"fix: added something" - will bump the patch version
71+
"feat: added something" - will bump the minor version
72+
"feat!: added something" - will bump the major version
73+
```
7974

8075
### Other resume standards
81-
* [HR-XML](https://schemas.liquid-technologies.com/HR-XML/2007-04-15/)
82-
* [Europass](http://europass.cedefop.europa.eu/about-europass)
76+
77+
- [HR-XML](https://schemas.liquid-technologies.com/HR-XML/2007-04-15/)
78+
- [Europass](http://europass.cedefop.europa.eu/about-europass)

0 commit comments

Comments
 (0)