Skip to content

Commit 1fef389

Browse files
committed
Updated README
1 parent c3ddcd7 commit 1fef389

File tree

1 file changed

+10
-19
lines changed

1 file changed

+10
-19
lines changed

README.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
# BanglaString
2-
A wannabe all-in-all Bangla String Manupulation Library!
2+
A wannabe all-in-all Bangla String manipulation/transformation library for PHP.
33

44

5-
6-
Hey there! **BanglaString** is willing to be the full featured, all in all, "Bengali" text manipulation library, for PHP. Right now, at its core, it supports translating aka converting Bengali text to **Avro Unicode** from **Bijoy ANSI** and vice-versa. However, in future, we are planning to add more Translator to its core.
7-
85
### Install via composer
96

107
```shell
@@ -23,30 +20,24 @@ require 'src/autoload.php';
2320

2421
## Supported Translators
2522

26-
### AvroUnicode
23+
### AvroToBijoy
2724

28-
Takes Bengali strings written in Avro Unicode and translates into Bijoy ANSI
25+
Takes Bengali strings written in Avro Unicode and translates into Bijoy Classic ANSI
2926

3027
Usage:
3128

3229
```php
33-
require 'vendor/autoload.php';
34-
35-
use MirazMac\BanglaString\BanglaString;
36-
$wizard = new BanglaString('জানার আছে অনেক কিছু!');
37-
echo $wizard->toBijoy();
30+
$translator = new \MirazMac\BanglaString\Translator\AvroToBijoy\Translator;
31+
echo $translator->translate('জানার আছে অনেক কিছু');
3832
```
3933

40-
### BijoyAnsi
34+
### BijoyToAvro
4135

42-
Takes Bengali strings written in Bijoy ANSI and translates into Avro Unicode
36+
Takes Bengali strings written in Bijoy Classic ANSI and translates into Avro Unicode
4337

4438
Usage:
4539

4640
```php
47-
require 'vendor/autoload.php';
48-
49-
use MirazMac\BanglaString\BanglaString;
50-
$wizard = new BanglaString('Rvbvi Av?Q A?bK wKQz!');
51-
echo $wizard->toAvro();
52-
```
41+
$translator = new \MirazMac\BanglaString\Translator\BijoyToAvro\Translator;
42+
echo $translator->translate('Rvbvi Av?Q A?bK wKQz!');
43+
```

0 commit comments

Comments
 (0)