locomotivemtl / charcoal-contrib-foobar
A Charcoal module to generate a google static map compatible url
dev-master / 0.1.x-dev
2020-02-11 18:59 UTC
Requires
- php: >7.1
- emcconville/google-map-polyline-encoding-tool: ~1.2.1
Requires (Dev)
- php-coveralls/php-coveralls: ^2.2
- phpunit/phpunit: ^7.1
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-11-12 05:40:28 UTC
README
A Charcoal service provider my cool feature.
Table of Contents
Installation
The preferred (and only supported) method is with Composer:
$ composer require locomotivemtl/charcoal-contrib-google-static-map
Dependencies
Required
- PHP 7.1+: PHP 7.3+ is recommended.
PSR
--TBD--
Service Provider
Parameters
--TBD--
Services
--TBD--
Configuration
--TBD--
Usage
--TBD--
Development
To install the development environment:
$ composer install
To run the scripts (phplint, phpcs, and phpunit):
$ composer test
API Documentation
- The auto-generated
phpDocumentor
API documentation is available at:
https://locomotivemtl.github.io/charcoal-contrib-google-static-map/docs/master/ - The auto-generated
apigen
API documentation is available at:
https://codedoc.pub/locomotivemtl/charcoal-contrib-google-static-map/master/
Development Dependencies
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
Coding Style
The charcoal-contrib-google-static-map module follows the Charcoal coding-style:
- PSR-1
- PSR-2
- PSR-4, autoloading is therefore provided by Composer.
- phpDocumentor comments.
- phpcs.xml.dist and .editorconfig for coding standards.
Coding style validation / enforcement can be performed with
composer phpcs
. An auto-fixer is also available withcomposer phpcbf
.
Credits
License
Charcoal is licensed under the MIT license. See LICENSE for details.