Skip to content

Commit 5c4c67a

Browse files
authored
Add note to readme
1 parent 53ab519 commit 5c4c67a

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AddressFinder for SilverStripe
1+
# AddressFinder for Silverstripe
22

33
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/fullscreeninteractive/silverstripe-addressfinder/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/fullscreeninteractive/silverstripe-addressfinder/?branch=master)
44
[![Build Status](https://travis-ci.org/fullscreeninteractive/silverstripe-addressfinder.svg?branch=master)](https://travis-ci.org/fullscreeninteractive/silverstripe-addressfinder)
@@ -13,19 +13,29 @@
1313

1414
## Overview
1515

16-
This module provides a custom `AddressFinderField` which implements the
17-
javascript AddressFinder widget ([1](http://addressfinder.co.nz/docs/widget_docs))
16+
This module provides a custom Silverstripe `AddressFinderField` which implements the
17+
javascript AddressFinder widget ([1](http://addressfinder.co.nz/docs/widget_docs)) for address and postcode lookups in New Zealand and Australia.
18+
19+
## Getting Started
1820

1921
To get started, sign up for an account at
2022
[addressfinder.co.nz/plans](http://addressfinder.co.nz/plans) and set your
21-
AddressFinder key values via the Config system
23+
AddressFinder key values via the Silverstripe Config system
2224

2325
*mysite/_config/addressfinder.yml*
2426
```
2527
FullscreenInteractive\SilverStripe\AddressFinderField:
2628
api_key: 123
2729
```
2830

31+
Or you can use environment variables if you prefer
32+
33+
*mysite/_config/addressfinder.yml*
34+
```
35+
FullscreenInteractive\SilverStripe\AddressFinderField:
36+
api_key: '`ADDRESS_FINDER_KEY`'
37+
```
38+
2939
Then add an instance of `AddressFinderField` to your form fields
3040

3141
```
@@ -82,8 +92,8 @@ class AddressObject extends DataObject
8292
}
8393
```
8494

85-
To prefix these fields, call `setFieldPrefix($prefix)` on your
86-
`AddressFinderField` instance.
95+
To prefix these fields, call `setFieldPrefix($prefix)` on your `AddressFinderField`
96+
instance.
8797

8898
```php
8999
AddressFinderField::create('HomeAddress')

0 commit comments

Comments
 (0)