Skip to content

Commit

Permalink
docu: changed documentation to reflect new settings structure
Browse files Browse the repository at this point in the history
  • Loading branch information
bweinzierl committed Feb 28, 2023
1 parent 398e252 commit d560912
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ but you can use Google API, too.

## What does it do?

This package provides a service class for geo-indexing addresses. Also a php trait to use in domain models is contained.
This package provides a service class for geo-indexing addresses. Also a php trait to use in domain models is provided.
This trait can be used to create a domain model that automatically fetches the geo location when the address is changed.


Expand Down Expand Up @@ -37,15 +37,23 @@ Provide the geonames username (that you have to create on the geonames website)
```
FormatD:
GeoIndexable:
geoIndexService:
geonamesEnable: true
geonamesUsername: ''
services:
geonames:
enabled: true
options:
username: ''
```

In case you want to use the Google API, you have to provide your API Key
```
FormatD:
GeoIndexable:
geoIndexService:
googleApiKey: ''
```
services:
google:
enabled: false
options:
apiKey: 'ichbineinapikey'
```



0 comments on commit d560912

Please sign in to comment.