Skip to content

Commit

Permalink
Published on Packagist. Added to README.md how to install it using co…
Browse files Browse the repository at this point in the history
…mposer.
  • Loading branch information
Luís Nóbrega committed Nov 29, 2019
1 parent c3c9cf9 commit 27ef36e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Integration tests.
- This CHANGELOG file to hopefully serve as an evolving example of a
standardized open source project CHANGELOG.

## [0.0.2] - 2019-11-29
### Added
- Published on Packagist. Added to README.md how to install it using composer.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

This is a package who validates if a Resume is in JSON Resume format. It also validates if any desired properties are not empty.

The validations it makes are, if:
The validations that makes are, if:

- It complies with JSON Schema of JSON Resume.
- It has certain fields filled in. These are configurable.
- It has certain fields filled in. This is configurable.

## Installing

```
composer require lfbn/json-resume-validator
```

## Usage

Expand Down Expand Up @@ -35,7 +41,7 @@ $resume->isValid();

Available parameters:

* mandatory_fields: they should be provided using dot notation. For example, to make name from basics mandatory, send an element with a string "basics.name".
* mandatory_fields: they should be provided using dot notation. For example, to make name from basics mandatory, send a string "basics.name".

## Integration Tests

Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "lfbn/json-resume-validator",
"description": "Validate your JSON Resume",
"version": "0.0.1",
"version": "0.0.2",
"keywords": [
"JSON Resume", "JSON Schema"
],
Expand Down

0 comments on commit 27ef36e

Please sign in to comment.