Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Altered documentation on custom ex libris files.
  • Loading branch information
OmeBlues committed Dec 6, 2014
1 parent fc9b9f0 commit 6cf677e
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,6 @@ The available options are as follows. Refer to the API Documentation for details
- downloadlimit (int)

#### optional:
- exlibrisfile (string), this should contain the location of a png-file according to the specifications in the API Documentation.
- exlibrisfont (string), this should contain either 'sans', 'serif' or 'script'
- exlibris (bool), default: false
- chapterfooter (bool), default: false
Expand All @@ -110,6 +109,12 @@ The available options are as follows. Refer to the API Documentation for details
- epub (bool), default: true
- kf8mobi (bool), default: false

#### custom ex libris
It is also possible to set a custom ex libris file according to the specifications in the API Documentation.
```php
$BooXtream->setExlibrisFile('filename');
```

### Response

The BooXtreamClient returns an object of the type of [Guzzle/Http/Message/Response](http://api.guzzlephp.org/class-Guzzle.Http.Message.Response.html)
Expand Down

0 comments on commit 6cf677e

Please sign in to comment.