Skip to content

Commit

Permalink
Merge pull request #6 from bbc/readying-for-2.0
Browse files Browse the repository at this point in the history
Updating README
  • Loading branch information
votemike authored Apr 27, 2017
2 parents 54ff022 + cbf42c4 commit eea7843
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ dependency.
}
],
"require": {
"bbc/branding-client": "^1.3"
"bbc/branding-client": "^2.0"
}
}
```
Expand All @@ -40,7 +40,7 @@ to the call to the Orbit webservice along with blocks of HTML that should be
injected into your page layout.

Create a BrandingClient, passing in an instance of `GuzzleHttp\Client`, an
implementation of `Doctrine\Common\Cache`, and optionally an options array. Then
implementation of `Psr\Cache\CacheItemPoolInterface`, and optionally an options array. Then
call `getContent()` to make a request and return a `Branding` domain model.

After that make a call to the OrbitClient, passing in the Variant and Language
Expand All @@ -54,8 +54,9 @@ want to support previewing not-yet-published themes.

```php
$httpClient = new \GuzzleHttp\Client();
$cache = new \Doctrine\Common\Cache\ArrayCache();
$cache = new \Symfony\Component\Cache\Adapter\ArrayAdapter();
$brandingOptions = [];
$orbitOptions = [];
$projectId = 'br-0001';
$themeVersionId = null;
// If you want to support the preview query strings suggested by the Branding
Expand Down Expand Up @@ -144,6 +145,6 @@ License
-------

This repository is available under the terms of the Apache 2.0 license.
View the LICENSE file in the for more information.
View the [LICENSE file](LICENSE) for more information.

Copyright (c) 2017 BBC

0 comments on commit eea7843

Please sign in to comment.