Skip to content

Commit

Permalink
test with emojis
Browse files Browse the repository at this point in the history
  • Loading branch information
hitblast committed Feb 17, 2024
1 parent fd59863 commit 2086933
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ A modern Pythonic implementation of the popular Bengali phonetic-typing software

</div>

## Overview
## Overview

**avro.py** provides a fully fledged, batteries-included text parser which can parse, reverse and even convert English Roman script into its phonetic equivalent (unicode) of Bengali. At its core, it implements an extensively modified version of the **Avro Phonetic Dictionary Search Library** by [Mehdi Hasan Khan](https://github.com/mugli).

> The original project ([pyAvroPhonetic](https://github.com/kaustavdm/pyAvroPhonetic)) can only be used on versions up to **Python 2.7** and doesn't contain proper support for Python's third major version AKA Python 3. It is noteworthy that Python 2 has officially been deprecated by the original maintainers and its usage is being discouraged overall. <br>
## Inspirations
## Inspirations

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

<br>

## Installation
## 🔨 Installation

This package requires **Python 3.8 or higher** to be used inside your development environment.

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

<br>

## Usage Guide
## 🔖 Usage Guide

### 1. `parse()`
This is the most basic use case for avro.py, which includes parsing English Roman script to unicode Bengali:
Expand Down Expand Up @@ -85,7 +85,7 @@ reversed_text = avro.reverse('আমার সোনার বাংলা।')

<br>

## Contributing
## 🛠️ Contributing

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

Expand All @@ -109,15 +109,15 @@ $ python3 -m pytest --verbose
# The --verbose / -v flag is used to show all the test results in detail.
```

### We're looking for bug hunters, by the way!
### 🐛 We're looking for bug hunters, by the way!

If you come across any kind of bug or wanna request a feature, please let us know by opening an issue [here](https://github.com/hitblast/avro.py/issues). We do need more ideas to keep the project alive and running, don't we? :P

---

<br>

## Acknowledgements
## 👑 Acknowledgements

- [Mehdi Hasan Khan](https://github.com/mugli) for originally developing and maintaining [Avro Phonetic](https://github.com/omicronlab/Avro-Keyboard).
- [Rifat Nabi](https://github.com/torifat) for porting it to Javascript.
Expand All @@ -127,6 +127,6 @@ If you come across any kind of bug or wanna request a feature, please let us kno

<br>

## License
## 📋 License

Licensed under the [MIT License](https://github.com/hitblast/avro.py/blob/main/LICENSE).

0 comments on commit 2086933

Please sign in to comment.