Charcoal Translatable Strings
![License][badge-license]
![Code Quality][badge-scrutinizer]
![Build Status][badge-travis], (*1)
A Charcoal service allowing an Admin user to translate hardcoded strings found in templates and controllers., (*2)
Table of Contents
Installation
The preferred (and only supported) method is with Composer:, (*3)
$ composer require locomotivemtl/charcoal-contrib-translatable-strings
Dependencies
Required
PSR
--TBD--, (*4)
Service Provider
Parameters
--TBD--, (*5)
Services
--TBD--, (*6)
Configuration
--TBD--, (*7)
Usage
--TBD--, (*8)
Development
To install the development environment:, (*9)
$ composer install
To run the scripts (phplint, phpcs, and phpunit):, (*10)
$ composer test
API Documentation
Development Dependencies
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
Coding Style
The charcoal-contrib-translatable-strings module follows the Charcoal coding-style:, (*11)
Coding style validation / enforcement can be performed with composer phpcs
. An auto-fixer is also available with composer phpcbf
., (*12)
Credits
License
Charcoal is licensed under the MIT license. See LICENSE for details., (*13)