Skip to content

Commit bd2ea19

Browse files
authored
Updated readme
1 parent 04ac0c9 commit bd2ea19

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Transliterate
22
Небольшой пакет для транслитерации кирилицы :poop:
33

4-
>#####Дисклеймер
4+
### Дисклеймер
55
>Работать - работает. Сорян, если что не так.
66
77
Умеет:
8-
* строку в url
9-
* строку в имя файла
8+
* строку в url ```['type' => 'url']```
9+
* строку в имя файла ```['type' => 'filename']```
1010

11-
#####Установка:
11+
### Установка:
1212
```
1313
composer require elforastero/transliterate
1414
```
@@ -17,24 +17,26 @@ composer require elforastero/transliterate
1717
//config/app.php
1818

1919
'providers' => [
20-
/*
21-
* Package Service Providers...
22-
*/
20+
//...
2321
ElForastero\Transliterate\TransliterationServiceProvider::class,
2422
],
2523

2624
'aliases' => [
25+
//...
2726
'Transliterate' => ElForastero\Transliterate\TransliterationFacade::class,
2827
],
2928
```
3029

31-
#####Использование:
30+
### Использование:
3231
```php
3332
use Transliterate;
3433
...
3534

3635
$string = '\'"#^_^ Если б мишки были пчёлами, то они бы нипочем, никогда и не подумали так высо́ко строить дом.';
3736

37+
$string = Transliterate::make($string);
38+
// Esli b mishki bili pchyolami to oni bi nipochem nikogda i ne podumali tak visoko stroit dom
39+
3840
$string = Transliterate::make($string, ['type' => 'url', 'lowercase' => true]);
3941
// esli-b-mishki-bili-pchyolami-to-oni-bi-nipochem-nikogda-i-ne-podumali-tak-visoko-stroit-dom
4042

@@ -45,16 +47,19 @@ $string = Transliterate::make($string, ['type' => 'url', 'lowercase' => true, 'm
4547
// esli-b-mishki-by'li-pchyolami-to-oni-by'-nipochem-nikogda-i-ne-podumali-tak-vy'soko-stroit`-dom
4648
```
4749

48-
#####Доступные параметры:
50+
### Доступные параметры:
4951
```php
5052
[
51-
'type' => 'url', // 'url' или 'filename'. Первым заменяем пробелы на '-', вторым на '_'. По дефолту 'url'.
52-
'lowercase' => true, // Преобразовать в нижний регистр.
53+
'type' => 'url',
54+
// 'url', 'filename' или 'text'. Первым заменяем пробелы на '-', вторым на '_'.
55+
// По дефолту 'text', который ничего не заменяет.
56+
57+
'lowercase' => true, // Преобразовать строку в нижний регистр.
5358
'map' => 'gost2000', // Транслитерация по ГОСТ 7.79-2000.
5459
]
5560
```
5661

57-
#####Дополнительно
62+
### Дополнительно
5863
```php
5964
// Получить карту транслитерации, используемую по-умолчанию
6065
Transliteration::getDefaultMap();

0 commit comments

Comments
 (0)