Skip to content

Commit

Permalink
added CLI docs and removed tobijoy (bijoy kinda sucks)
Browse files Browse the repository at this point in the history
  • Loading branch information
hitblast committed Mar 31, 2024
1 parent cdc65ba commit c0e85b7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,19 @@ Finally, you can reverse unicode Bengali to English as well (newly added).
reversed_text = avro.reverse('আমার সোনার বাংলা।')
```

---

or, you can use the command line interface (CLI) to interact with the package:

```bash
# Parsing some text.
$ avro parse "tumi onek bhalO!"
$ avro parse --bijoy "amio kharap na, taina?" # (bijoy keyboard format)

# Reversing.
$ avro reverse "তাই তো!"
```

<br>

## 🛠️ Contributing
Expand Down
6 changes: 0 additions & 6 deletions avro/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,6 @@ def cli():
def _parse(text: str, bijoy: bool = False):
click.echo((avro.parse(text) if not bijoy else avro.parse(text, bijoy=True)))

# usage: avro tobijoy <text>
@cli.command('tobijoy', help='Convert a given text to Bijoy Keyboard format.')
@click.argument('text')
def _tobijoy(text: str):
click.echo(avro.to_bijoy(text))

# usage: avro reverse <text>
@cli.command('reverse', help='Reverse a given text to English.')
@click.argument('text')
Expand Down

0 comments on commit c0e85b7

Please sign in to comment.