Skip to content

Commit

Permalink
Updating readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
karllhughes committed Sep 2, 2016
1 parent 542b3cf commit 2a2b77c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 20 deletions.
15 changes: 4 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,14 @@
# Changelog
All Notable changes to `jobs-common` will be documented in this file

## 2.0.0-beta - 2016-08-26
## 2.0.0-beta - 2016-09-01

### Added
- Moving required, default, and valid params to abstract methods
- Continued to refine queryParams array setter/getter methods from Alpha
- Included concrete provider in tests
- Moved API parameters to new Query object.
- Improved test coverage with concrete provider and query instances.

### Deprecated
- Nothing

### Fixed
- Nothing

### Security
- Nothing
- Old method of setting query parameters via the Provider's constructor or "setX()" methods removed

## 2.0.0-alpha - 2016-04-04

Expand Down
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,7 @@ You should use your own username as the vendor prefix, and prepend `jobs-` to th
If you are working with a job board service not supported out-of-the-box or by an existing package, it is quite simple to implement your own. Simply extend `JobApis\Jobs\Client\Providers\AbstractProvider` and implement the required abstract methods:

```php
abstract public function createJobObject($payload);
abstract public function getFormat();
abstract public function getListingsPath();
abstract public function getKeyword();
abstract public function getVerb();
// Documentation coming soon
```

Each of these abstract methods contain a docblock defining their expectations and typical behaviour. Once you have extended this class, you can simply follow the example above using your new `Provider`.
Expand Down Expand Up @@ -112,16 +108,12 @@ $ ./vendor/bin/phpunit

Please see [CONTRIBUTING](https://github.com/jobapis/jobs-common/blob/master/CONTRIBUTING.md) for details.


## Credits

- [Karl Hughes](https://github.com/karllhughes)
- [Steven Maguire](https://github.com/stevenmaguire)
- [All Contributors](https://github.com/jobapis/jobs-common/contributors)


## License

The Apache 2.0. Please see [License File](https://github.com/jobapis/jobs-common/blob/master/LICENSE) for more information.

:)

0 comments on commit 2a2b77c

Please sign in to comment.