|
1 |
| -# AddressFinder for SilverStripe |
| 1 | +# AddressFinder for Silverstripe |
2 | 2 |
|
3 | 3 | [](https://scrutinizer-ci.com/g/fullscreeninteractive/silverstripe-addressfinder/?branch=master)
|
4 | 4 | [](https://travis-ci.org/fullscreeninteractive/silverstripe-addressfinder)
|
|
13 | 13 |
|
14 | 14 | ## Overview
|
15 | 15 |
|
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 |
18 | 20 |
|
19 | 21 | To get started, sign up for an account at
|
20 | 22 | [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 |
22 | 24 |
|
23 | 25 | *mysite/_config/addressfinder.yml*
|
24 | 26 | ```
|
25 | 27 | FullscreenInteractive\SilverStripe\AddressFinderField:
|
26 | 28 | api_key: 123
|
27 | 29 | ```
|
28 | 30 |
|
| 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 | + |
29 | 39 | Then add an instance of `AddressFinderField` to your form fields
|
30 | 40 |
|
31 | 41 | ```
|
@@ -82,8 +92,8 @@ class AddressObject extends DataObject
|
82 | 92 | }
|
83 | 93 | ```
|
84 | 94 |
|
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. |
87 | 97 |
|
88 | 98 | ```php
|
89 | 99 | AddressFinderField::create('HomeAddress')
|
|
0 commit comments