Skip to content

Commit

Permalink
added function beside use case headers
Browse files Browse the repository at this point in the history
  • Loading branch information
hitblast committed Feb 17, 2024
1 parent 647ba3f commit be70dcc
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ $ pip install -U avro.py

## Usage Guide

### 1. Parsing (Default)
This is the most basic use case for avro.py, which includes parsing English Roman script to Bengali by calling the `parse()` function like this:
### 1. Parsing (Default): `parse()`
This is the most basic use case for avro.py, which includes parsing English Roman script to unicode Bengali:

```python
# Imports.
Expand All @@ -59,15 +59,15 @@ output = avro.parse('ami banglay gan gai.')
print(output)
```

### 2. Parsing (Bijoy Keyboard)
### 2. Parsing (Bijoy Keyboard): `parse(bijoy=True)`
Alternatively, we can generate the same output, but in compliance with the Bijoy Keyboard format:

```python
# Parsing some text in Bijoy!
output = avro.parse('tumi emon keno?', bijoy=True)
```

### 3. Avro to Bijoy Conversion
### 3. Avro to Bijoy Conversion: `to_bijoy()`
We can also use avro.py to convert existing unicode Bengali to its Bijoy Keyboard equivalent:

```python
Expand All @@ -76,7 +76,7 @@ bijoy_text = avro.to_bijoy('আমি বাংলায় গান গাই।'
print(bijoy_text)
```

### 4. Reversing Text
### 4. Reversing Text: `reverse()`
Finally, you can reverse unicode Bengali to English as well (newly added).

```python
Expand Down

0 comments on commit be70dcc

Please sign in to comment.