Skip to content

Commit

Permalink
Updating readme, docs
Browse files Browse the repository at this point in the history
  • Loading branch information
karllhughes committed Feb 9, 2017
1 parent b8f8809 commit 70585f3
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ $ composer require jobapis/jobs-goremote

## Usage

GoRemote provides no search parameters, just a feed of all their latest jobs via RSS. In order to grab jobs, first create a query object.
GoRemote provides no search parameters, just a feed of all their latest jobs via RSS. In order to get the latest job listings, first create a query object.

```php
$query = new JobApis\Jobs\Client\Queries\GoRemoteQuery();
Expand All @@ -63,13 +63,15 @@ $jobs = $client->getJobs();
The `getJobs()` method will return a [Collection](https://github.com/jobapis/jobs-common/blob/master/src/Collection.php) of [Job](https://github.com/jobapis/jobs-common/blob/master/src/Job.php) objects based on Schema.org's [JobPosting](https://schema.org/JobPosting) specification.


## Testing and Development
## Testing

1. Clone this repository from Github
1. Clone this repository from Github.
2. Install the dependencies with Composer: `$ composer install`.
3. Run the test suite: `$ ./vendor/bin/phpunit`.
4. (Optional) Run the test suite with real HTTP calls to the API: `$ REAL_CALL=1 ./vendor/bin/phpunit`.

A code coverage report will be generated in the `build/` directory at the root of the project.


## Contributing

Expand All @@ -87,4 +89,4 @@ This package uses the Apache 2.0 license. Please see the [License File](#) for m

### Copyright

Copyright 2017, [Karl Hughes](https://github.com/karllhughes)
Copyright 2017, [Karl Hughes](https://github.com/karllhughes).

0 comments on commit 70585f3

Please sign in to comment.