Skip to content

Commit

Permalink
Update CHANGELOG and README for namespaced resources and flavors
Browse files Browse the repository at this point in the history
  • Loading branch information
zorbash committed Feb 28, 2016
1 parent 4763f65 commit 0008451
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased

### Added

* Ability to specify flavor upon initialization

```ruby
client = Skroutz::Client.new('client_id', 'client_secret', flavor: :scrooge)
# client now points to scrooge.co.uk for authentication and API requests
```

### Changed

* Resource classes are namespaced under Skroutz::Resources

## [0.2.0] - 2016-01-04

### Added
Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ gem 'skroutz'
skroutz = Skroutz::Client.new('client_id', 'client_secret')
```

##### Note
> You may pass the `flavor` keyword argument upon initialization to target one of the
> available flavors (`skroutz`, `alve`, `scrooge`), default is `skroutz`.
## Search

```ruby
Expand Down Expand Up @@ -205,6 +209,16 @@ You may even try more complex things like:

The following configuration options are available upon client initialization:

### flavor

Which flavor (eg. country) to target.
**Default**: `skroutz`.

```ruby
# Set `scrooge` as the flavor
client = Skroutz::Client.new('client_id', 'client_secret', flavor: :scrooge)
```

### logger

Which logger to use.
Expand Down

0 comments on commit 0008451

Please sign in to comment.