Rudloff / epikoinos

Convert French words to their epicene form
http://epikoinos.netlib.re/
GNU General Public License v3.0
2 stars 2 forks source link

Epíkoinos

Convert French words to their epicene form

Usage

As a library

require_once __DIR__.'/vendor/autoload.php';
use Epíkoinos\Converter;
$converter = new Converter();

Convert a word

$converter->convertWord('étudiant'); //['étudiant.e' => ['feminine' => 'étudiante', 'masculine' => 'étudiant', 'epicene' => 'étudiant.e']]

Note that it will always return an array (as there might be several possible conversions).

Use a custom delimiter

$converter = new Converter('-');
$converter->convertWord('étudiant'); //['étudiant-e' => ['feminine' => 'étudiante', 'masculine' => 'étudiant', 'epicene' => 'étudiant-e']]

Documentation

The complete library documentation is available at epikoinos.netlib.re/docs/.

As a web app

Epíkoinos can also be used as a web app. The official instance is hosted at epikoinos.netlib.re.

Setup

composer install
bower install