From 1fef3895620f6908e6379d85af74976bafcd78f0 Mon Sep 17 00:00:00 2001 From: Miraz Mac Date: Tue, 19 Oct 2021 13:26:20 +0600 Subject: [PATCH] Updated README --- README.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 00d4fbb..cf78df9 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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(); -``` \ No newline at end of file +$translator = new \MirazMac\BanglaString\Translator\BijoyToAvro\Translator; +echo $translator->translate('Rvbvi Av?Q A?bK wKQz!'); +```