Skip to content

Commit 4e798f4

Browse files
committed
docs: Describe configuration options
1 parent bf7e324 commit 4e798f4

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,16 @@ $project = new Project(
3737
```shell
3838
$ composer require plook/type-guard
3939
```
40+
41+
## Configuration
42+
43+
### Setting the default target time zone of `DateTimeImmutable` objects
44+
```php
45+
Convert::timeZone('Australia/Adelaide');
46+
Convert::timeZone(new DateTimeZone('Australia/Adelaide'));
47+
```
48+
49+
### Setting the default format of date time strings
50+
```php
51+
Convert::dateTimeFormat(DateTimeInterface::ATOM);
52+
```

0 commit comments

Comments
 (0)