-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
REFACTOR README updates and cleanup (#26)
- Loading branch information
Showing
9 changed files
with
55 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
npm-debug.log | ||
node_modules/ | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,28 +25,59 @@ Display a map, directions, and contact info for your location. | |
Adds a Customer Service block to display a map, directions and contact info for your location. Userful for a Contact Us page. | ||
|
||
### Note | ||
In order to use the Geocoder and address map, you will have to create an [API key](https://developers.google.com/maps/documentation/javascript/get-api-key). It can be configured in your YML file like this: | ||
In order to use the Geocoder and address map, you will need to set two [Google API keys](https://developers.google.com/maps/documentation/javascript/get-api-key). Each key needs to have specific API libraries enabled: | ||
* `geocoder_api_key` | ||
* Geocoding API | ||
* `map_api_key` | ||
* Maps JavaScript API | ||
* Maps Static API | ||
|
||
They can be set in your YML file like this: | ||
|
||
``` | ||
Dynamic\SilverStripeGeocoder\GoogleGeocoder: | ||
geocoder_api_key: 'your-key-here' | ||
map_api_key: 'your-key-here' | ||
``` | ||
|
||
For more, see [Silverstripe Geocoder](https://github.com/dynamic/silverstripe-geocoder#google-api-keys) | ||
|
||
## Screen Shots | ||
|
||
#### Front End sample of a Customer Service Element | ||
![Front End sample of a Customer Service Element](./readme-images/customer-service-block-sample.jpg) | ||
![Front End sample of a Customer Service Element](./docs/en/_images/customer-service-block-sample.png) | ||
|
||
#### CMS - Customer Service Element Main Tab | ||
![CMS - Customer Service Element Main Tab](./readme-images/customer-service-block-cms.jpg) | ||
![CMS - Customer Service Element Main Tab](./docs/en/_images/customer-service-block-cms.png) | ||
|
||
#### CMS - Customer Service Element - Address Tab | ||
![CMS - Customer Service Element - Address Tab](./readme-images/customer-service-block-cms-address.jpg) | ||
![CMS - Customer Service Element - Address Tab](./docs/en/_images/customer-service-block-cms-address.png) | ||
|
||
## Getting more elements | ||
|
||
See [Elemental modules by Dynamic](https://github.com/dynamic/silverstripe-elemental-blocks#included-blocks) | ||
See [Elemental modules by Dynamic](https://github.com/orgs/dynamic/repositories?q=elemental&type=all&language=&sort=) | ||
|
||
## Configuration | ||
|
||
See [SilverStripe Elemental Configuration](https://github.com/dnadesign/silverstripe-elemental#configuration) | ||
|
||
## Maintainers | ||
|
||
* [Dynamic](http://www.dynamicagency.com) (<[email protected]>) | ||
|
||
## Bugtracker | ||
Bugs are tracked in the issues section of this repository. Before submitting an issue please read over | ||
existing issues to ensure yours is unique. | ||
|
||
If the issue does look like a new bug: | ||
|
||
- Create a new issue | ||
- Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots | ||
and screencasts can help here. | ||
- Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, | ||
Operating System, any installed SilverStripe modules. | ||
|
||
Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker. | ||
|
||
## Development and contribution | ||
If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.