Skip to content

Commit

Permalink
updated markdown file
Browse files Browse the repository at this point in the history
Signed-off-by: HitBlast <[email protected]>
  • Loading branch information
hitblast committed Aug 24, 2024
1 parent 8a5e9c8 commit ef28e58
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A modern Pythonic implementation of the popular Bengali phonetic-typing software
## ✨ Inspirations

This package is inspired from Rifat Nabi's jsAvroPhonetic library and derives from Kaustav Das Modak's pyAvroPhonetic.
This package is inspired from Rifat Nabi's jsAvroPhonetic library and derives from Kaustav Das Modak's pyAvroPhonetic.

<br>

Expand All @@ -48,7 +48,7 @@ $ pip install avro.py

[**avnie**](https://github.com/hitblast/avnie) is a newly developed CLI tool that uses avro.py under the hood. You can install it using:

```sh
```sh
# Install / upgrade avnie.
$ pip install avnie
```
Expand All @@ -60,6 +60,7 @@ $ pip install avnie
This small tour guide will describe how you can use avro.py back and forth to operate (cutlery!) on Bengali text. You can also check the [examples](https://github.com/hitblast/avro.py/tree/main/examples) directory for checking [this whole snippet](https://github.com/hitblast/avro.py/blob/main/examples/simple.py) in action, as well as other use cases.

#### 1. `parse()`

Let's assume I want to parse some English text to Bengali, which is "ami banglay gan gai.", so in this case to convert it to Bengali, we can use this snippet:

```python
Expand All @@ -75,6 +76,7 @@ print(output) # Output: আমি বাংলায় গান গাই।
```

#### 2. `parse(bijoy=True)`

Alternatively, I can also do it in Bijoy Keyboard format:

```python
Expand All @@ -83,6 +85,7 @@ bijoy_output = avro.parse(dummy, bijoy=True) # Output: Avwg evsjvh় Mvb MvB
```

#### 3. `to_bijoy()`

Or, we can take the previous `avro_output` and convert it to Bijoy if we want to, like this:

```python
Expand All @@ -91,6 +94,7 @@ bijoy_text = avro.to_bijoy(avro_output) # Output: Avwg evsjvh় Mvb MvB।
```

#### 4. `to_unicode()`

Conversely, we can convert the Bijoy text we got just now and convert it back to Unicode Bengali:

```python
Expand All @@ -99,6 +103,7 @@ unicode_text = avro.to_unicode(bijoy_text) # Output: আমি বাংলা
```

#### 4. `reverse()`

Finally, we can just reverse back to the original text we passed as input in the first place:

```python
Expand All @@ -110,7 +115,7 @@ reversed_text = avro.reverse(uncode_text) # Output: ami banglay gan gai.

## 🛠️ Contributing

:octocat: *Fork -> Do your changes -> Send a Pull Request, it's that easy!* <br>
:octocat: _Fork -> Do your changes -> Send a Pull Request, it's that easy!_ <br>

---

Expand Down

0 comments on commit ef28e58

Please sign in to comment.