Skip to content

Commit 75162be

Browse files
author
Nicolas Cabot
committed
fixed readme, disable caching and logging by default
1 parent 6c7c746 commit 75162be

File tree

2 files changed

+13
-26
lines changed

2 files changed

+13
-26
lines changed

DependencyInjection/Configuration.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ public function getConfigTreeBuilder()
2424
->children()
2525
->scalarNode('api_key')->isRequired()->cannotBeEmpty()->end()
2626
->arrayNode('cache')
27-
->canBeDisabled()
27+
->canBeEnabled()
2828
->children()
2929
->scalarNode('path')->defaultValue('%kernel.cache_dir%/tmdb')->end()
3030
->end()
3131
->end()
3232
->arrayNode('log')
33-
->canBeDisabled()
33+
->canBeEnabled()
3434
->children()
3535
->scalarNode('path')->defaultValue('%kernel.logs_dir%/tmdb.log')->end()
3636
->end()

README.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,53 +14,40 @@ wtfz_tmdb:
1414
1515
That's all! Fire away!
1616
17-
__Default caching and loggin capabilities?__
17+
__Want to make use of default caching and/or logging?__
1818
1919
This caching system will adhere to the TMDB API max-age values, if you have different needs like long TTL's
2020
you'd have to make your own implementation. We would be happy to intergrate more options, so please contribute.
2121
22-
Default configuration looks like this :
23-
2422
```yaml
2523
wtfz_tmdb:
26-
...
24+
api_key: YOUR_API_KEY_HERE
2725
cache:
2826
enabled: true
29-
path: "%kernel.cache_dir%/tmdb"
27+
#path: "%kernel.cache_dir%/tmdb"
3028
log:
3129
enabled: true
32-
path: "%kernel.logs_dir%/tmdb.log"
30+
#path: "%kernel.logs_dir%/tmdb.log"
3331
```
3432

35-
You can disable if you don't want to use it :
33+
__Don't need the repositories?__
3634

37-
```yaml
38-
wtfz_tmdb:
39-
...
40-
cache:
41-
enabled: false
42-
log:
43-
enabled: false
44-
```
45-
46-
__Disable repositories?__
47-
48-
You can disable repositories if you don't use them :
35+
You can disable repositories :
4936

5037
```yaml
5138
wtfz_tmdb:
52-
...
39+
api_key: YOUR_API_KEY_HERE
5340
repositories:
5441
enabled: false
5542
```
5643
57-
__Disable twig extension?__
44+
__Don't need the twig extension?__
5845
59-
You can disable twig extension if you don't use it :
46+
You can disable the twig extension :
6047
6148
```yaml
6249
wtfz_tmdb:
63-
...
50+
api_key: YOUR_API_KEY_HERE
6451
twig_extension:
6552
enabled: false
6653
```
@@ -80,7 +67,7 @@ Obtaining repositories
8067
$movie = $this->get('wtfz_tmdb.movie_repository')->load(13);
8168
```
8269

83-
An overview of all the repositories can be found in the services configuration [tmdb.xml](https://github.com/wtfzdotnet/WtfzTmdbBundle/blob/master/Resources/config/tmdb.xml).
70+
An overview of all the repositories can be found in the services configuration [repositories.xml](https://github.com/wtfzdotnet/WtfzTmdbBundle/blob/master/Resources/config/repositories.xml).
8471

8572
There is also a Twig helper that makes use of the `Tmdb\Helper\ImageHelper` to output urls and html.
8673

0 commit comments

Comments
 (0)