feat(api): support the job search api endpoint

README.md

@@ -1,12 +1,20 @@
 # python-usajobsapi
 
-A Python wrapper for the [USAJOBS REST API](https://developer.usajobs.gov/). The library aims to provide a simple interface for discovering and querying job postings from USAJOBS using Python.
+A Python wrapper for the [USAJOBS REST API](https://developer.usajobs.gov/). The package aims to provide a simple SDK interface for discovering and querying job postings from USAJOBS using Python.
 
 ## Features
 
-- Lightweight client for the USAJOBS REST endpoints
-- Easily search for job postings with familiar Python types
-- No external dependencies required
+- Lightweight client for the USAJOBS REST API endpoints
+- Leverage type hinting and validation for endpoint parameters
+- Map endpoint results to Python objects
+
+### Supported Endpoints
+
+This package primarily aims to support searching and retrieval of active and past job listings. However, updates are planned to add support for all other documented endpoints.
+
+Currently, the following endpoints are supported:
+
+- [Job Search API](https://developer.usajobs.gov/api-reference/get-api-search) (`/api/Search`)
 
 ## Installation
 
@@ -16,6 +24,12 @@ A Python wrapper for the [USAJOBS REST API](https://developer.usajobs.gov/). The
 pip install python-usajobsapi
 ```
 
+or, with [astral-uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add python-usajobsapi
+```
+
 ### From source
 
 ```bash
@@ -29,12 +43,12 @@ pip install .
 Register for a USAJOBS API key and set a valid User-Agent before making requests.
 
 ```python
-from usajobsapi import USAJobs
+from usajobsapi import USAJobsClient
 
-client = USAJobs(user_agent="name@example.com", api_key="YOUR_API_KEY")
-results = client.search_jobs(keyword="data scientist", location="Remote")
+client = USAJobsClient(auth_user="name@example.com", auth_key="YOUR_API_KEY")
+results = client.search_jobs(keyword="data scientist", location_names=["Atlanta", "Georgia"]).search_result.jobs()
 for job in results:
-    print(job["Title"])
+    print(job.position_title)
 ```
 
 ## Contributing
@@ -50,11 +64,11 @@ Please open an issue first for major changes to discuss your proposal.
 
 ## License
 
-Distributed under the GNU General Public License v3.0. See [LICENSE](LICENSE) for details.
+Distributed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). See [LICENSE](LICENSE) for details.
 
 ## Project Status
 
-This project is under active development and the API may change. Feedback and ideas are appreciated.
+This project is under active development and its API may change. Changes to the [USAJOBS REST API documentation](https://developer.usajobs.gov/) shall be monitored and incorporated into this project in a reasonable amount of time. Feedback and ideas are appreciated.
 
 ## Contact