Skip to content

Commit 4a73378

Browse files
committed
Readme update
1 parent ecdbd36 commit 4a73378

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
[![Quality Score](https://img.shields.io/scrutinizer/g/JobBrander/jobs-govt.svg?style=flat-square)](https://scrutinizer-ci.com/g/JobBrander/jobs-govt)
88
[![Total Downloads](https://img.shields.io/packagist/dt/jobbrander/jobs-govt.svg?style=flat-square)](https://packagist.org/packages/jobbrander/jobs-govt)
99

10-
This package provides Government Jobs API support for the JobBrander's
11-
[Jobs Client](https://github.com/JobBrander/jobs-common).
10+
This package provides [Government Jobs API](http://search.digitalgov.gov/developer/jobs.html)
11+
support for the JobBrander's [Jobs Client](https://github.com/JobBrander/jobs-common).
1212

1313
## Installation
1414

@@ -27,8 +27,9 @@ as the provider.
2727
$client = new JobBrander\Jobs\Client\Provider\Govt();
2828

2929
// Search for 200 job listings for 'project manager' in Chicago, IL
30-
$jobs = $client->setKeyword('project manager')\
31-
->setCount(200)
30+
$jobs = $client->setKeyword('project manager') // Attempts to extract as much "signal" as possible from the input text. Handles word variants, so a search on "nursing jobs" will find a job titled "nurse practitioner" and "RN." When parts of the query parameter are used to search against the position title, the results are ordered by relevance. When no query parameter is specified, they are ordered by date with the most recent listed first.
31+
->setCount(100) // Specifies how many results are returned (up to 100 at a time)
32+
->setFrom(10) // Specifies the starting record
3233
->getJobs();
3334
```
3435

0 commit comments

Comments
 (0)