Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
MirazMac committed Oct 19, 2021
1 parent c3ddcd7 commit 1fef389
Showing 1 changed file with 10 additions and 19 deletions.
29 changes: 10 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# BanglaString
A wannabe all-in-all Bangla String Manupulation Library!
A wannabe all-in-all Bangla String manipulation/transformation library for PHP.



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.

### Install via composer

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

## Supported Translators

### AvroUnicode
### AvroToBijoy

Takes Bengali strings written in Avro Unicode and translates into Bijoy ANSI
Takes Bengali strings written in Avro Unicode and translates into Bijoy Classic ANSI

Usage:

```php
require 'vendor/autoload.php';

use MirazMac\BanglaString\BanglaString;
$wizard = new BanglaString('জানার আছে অনেক কিছু!');
echo $wizard->toBijoy();
$translator = new \MirazMac\BanglaString\Translator\AvroToBijoy\Translator;
echo $translator->translate('জানার আছে অনেক কিছু');
```

### BijoyAnsi
### BijoyToAvro

Takes Bengali strings written in Bijoy ANSI and translates into Avro Unicode
Takes Bengali strings written in Bijoy Classic ANSI and translates into Avro Unicode

Usage:

```php
require 'vendor/autoload.php';

use MirazMac\BanglaString\BanglaString;
$wizard = new BanglaString('Rvbvi Av?Q A?bK wKQz!');
echo $wizard->toAvro();
```
$translator = new \MirazMac\BanglaString\Translator\BijoyToAvro\Translator;
echo $translator->translate('Rvbvi Av?Q A?bK wKQz!');
```

0 comments on commit 1fef389

Please sign in to comment.