Skip to content

Commit fc18275

Browse files
authored
Update README.md (#59)
1 parent c4a88d4 commit fc18275

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,21 @@ Requires php 7.3 or newer.
2727
First configure the basic parameters, either using a DSN or as separate parameters:
2828

2929
```yaml
30-
unleash_symfony_client:
30+
unleash_client:
3131
dsn: http://localhost:4242/api&instance_id=myCoolApp-Server1&app_name=myCoolApp
3232
```
3333
3434
or
3535
3636
```yaml
37-
unleash_symfony_client:
37+
unleash_client:
3838
app_url: http://localhost:4242/api
3939
instance_id: myCoolApp-Server1
4040
app_name: myCoolApp
4141
```
4242
4343
> Tip: Generate the default config by running
44-
> `php bin/console config:dump unleash_symfony_client > config/packages/unleash_symfony_client.yaml`
44+
> `php bin/console config:dump unleash_client > config/packages/unleash_client.yaml`
4545
> which will create the default config file which you can then tweak
4646

4747
```php
@@ -196,7 +196,7 @@ field to use for the user id, by default it uses either the
196196
or `Symfony\Component\Security\Core\User\UserInterface::getUsername()`.
197197

198198
```yaml
199-
unleash_symfony_client:
199+
unleash_client:
200200
context:
201201
user_id_field: id
202202
```
@@ -216,7 +216,7 @@ your value to start with `>` and not be an expression, escape it using `\`. All
216216
variable which is either the user object or null.
217217

218218
```yaml
219-
unleash_symfony_client:
219+
unleash_client:
220220
context:
221221
custom_properties:
222222
myCustomProperty: someValue # just a good old string
@@ -284,7 +284,7 @@ disable any of them in case they would clash with your own functions/filters/tes
284284
The default is that everything is enabled if twig is installed.
285285

286286
```yaml
287-
unleash_symfony_client:
287+
unleash_client:
288288
twig:
289289
functions: true
290290
filters: true
@@ -392,7 +392,7 @@ If you want to make use of one of the default strategies, you can, all of them s
392392
If for some reason you want to disable any of the built-in strategies, you can do so in config.
393393

394394
```yaml
395-
unleash_symfony_client:
395+
unleash_client:
396396
disabled_strategies:
397397
- default
398398
- remoteAddress
@@ -405,7 +405,7 @@ By default the services are set to make use of `symfony/http-client`, `nyholm/ps
405405
You can overwrite the default values in config:
406406

407407
```yaml
408-
unleash_symfony_client:
408+
unleash_client:
409409
http_client_service: my_custom_http_client_service
410410
request_factory_service: my_custom_request_factory_service
411411
cache_service: my_custom_cache_service
@@ -440,7 +440,7 @@ final class MyBootstrap implements BootstrapProvider
440440
}
441441
```
442442
```yaml
443-
unleash_symfony_client:
443+
unleash_client:
444444
bootstrap: '@MyBootstrap'
445445
```
446446

@@ -453,7 +453,7 @@ Let's say you create a file called `bootstrap.json` in your config directory, th
453453
bootstrap:
454454

455455
```yaml
456-
unleash_symfony_client:
456+
unleash_client:
457457
bootstrap: 'file://%kernel.project_dir%/config/bootstrap.json'
458458
```
459459

@@ -470,7 +470,7 @@ Note that when you disable communication with Unleash and don't provide a bootst
470470
> The usually required parameters (app name, instance id, app url) are not required when communication is disabled.
471471

472472
```yaml
473-
unleash_symfony_client:
473+
unleash_client:
474474
bootstrap: '@MyBootstrap'
475475
cache_ttl: 0
476476
fetching_enabled: false
@@ -515,12 +515,12 @@ Options:
515515

516516
## Configuration reference
517517

518-
This is the autogenerated config dump (by running `php bin/console config:dump unleash_symfony_client`):
518+
This is the autogenerated config dump (by running `php bin/console config:dump unleash_client`):
519519

520520
```yaml
521-
# Default configuration for extension with alias: "unleash_symfony_client"
522-
# Default configuration for extension with alias: "unleash_symfony_client"
523-
unleash_symfony_client:
521+
# Default configuration for extension with alias: "unleash_client"
522+
# Default configuration for extension with alias: "unleash_client"
523+
unleash_client:
524524
525525
# You can provide the connection details as a DSN instead of app_url, instance_id and app_name. DSN takes precedence over individual parameters.
526526
dsn: null # Example: 'https://localhost:4242/api?instance_id=myCoolApp-Server1&app_name=myCoolApp'

src/DependencyInjection/Configuration.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public function __construct(
2727

2828
public function getConfigTreeBuilder(): TreeBuilder
2929
{
30-
$treeBuilder = new TreeBuilder('unleash_symfony_client');
30+
$treeBuilder = new TreeBuilder('unleash_client');
3131
$rootNode = $treeBuilder->getRootNode();
3232

3333
$rootNode

0 commit comments

Comments
 (0)