Skip to content

Commit

Permalink
Update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JustSteveKing committed Sep 21, 2020
1 parent b8eb7cb commit 73d32dc
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,19 @@

All notable changes to `companies-house-laravel` will be documented in this file

## 1.1.0 - 2022-09-17
## 1.2.0 - 2020-09-21

Adding fetching of Company Officers through the API by company number. This will return an OfficerCollection.

## 1.1.0 - 2020-09-17

Adding company search and more.

- Added the ability to search for a company using the company name.
- Added a new Company Collection, which when coming back from a search will be populated with SearchResult classes.
- Added the ability to fake the Http Client on the Client itself - for testing utilities.

## 1.0.0 - 2022-09-16
## 1.0.0 - 2020-09-16

The initial release allows users to:

Expand Down
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@


A Laravel wrapper to get companies house information and validate company numbers. This is a work in progress and more methods will be added to the API as they are required. Currently only Company Number is able to be passed to the API.

This has been tested thoroughly in Laravel 8, Laravel 7 is supported but if you find issues please do drop a detailed issue.

## Installation

You can install the package via composer:
Expand Down Expand Up @@ -40,7 +43,7 @@ return [

Using it inline:

``` php
```php
use JustSteveKing\CompaniesHouseLaravel\Client;

// Make a new client
Expand Down Expand Up @@ -78,6 +81,23 @@ $results->each(function ($result) {
});
```

Fetching a Collection of Company Officers will return an OfficerCollection:

```php
use JustSteveKing\CompaniesHouseLaravel\Client;

$api = Client::make();

// Get a collection of Company\SearchResult inside of a CompanyCollection
$results = $api->getOfficers('company-number');

// You now have access to all standard Laravel collection methods
$results->each(function ($result) {
// Do something with the result here.
});
```


## Testing

### Using this library in your own tests
Expand Down

0 comments on commit 73d32dc

Please sign in to comment.