Skip to content

Commit 8e61915

Browse files
committed
Added readme (#3)
1 parent c8c835c commit 8e61915

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

Readme.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,33 @@
66
[![Quality Score](https://img.shields.io/scrutinizer/g/php-translation/converter.svg?style=flat-square)](https://scrutinizer-ci.com/g/php-translation/converter)
77
[![Total Downloads](https://img.shields.io/packagist/dt/php-translation/converter.svg?style=flat-square)](https://packagist.org/packages/php-translation/converter)
88

9-
This is an PHP-translation storage adapter that uses Symfony's translation writer
10-
and loader.
9+
**Don't you hate all the different translations formats? Are you stuck with JMSTranslatorBundle? If so, this is the
10+
tool for you!**
11+
12+
This little tool can convert your translation files from one format to the excellent XLIFF 2.0. A perfect use case is
13+
when you migrating from JMSTranslatorBundle to [PHP-translation](http://php-translation.readthedocs.io/).
1114

1215
### Install
1316

1417
```bash
1518
composer require php-translation/converter
1619
```
1720

21+
### Use
22+
23+
Just run the command like below:
24+
25+
```bash
26+
# Example
27+
./vendor/bin/translation-converter [input_dir] [output_dir] [format]
28+
29+
# Convert from JMSTranslationBundle
30+
./vendor/bin/translation-converter app/Resources/translations app/Resources/translations-new jms
31+
32+
# Convert from Yaml
33+
./vendor/bin/translation-converter app/Resources/translations app/Resources/translations-new yml
34+
```
35+
1836
### Documentation
1937

2038
Read our documentation at [http://php-translation.readthedocs.io](http://php-translation.readthedocs.io/en/latest/).

0 commit comments

Comments
 (0)