Skip to content

Commit

Permalink
README.md completed.
Browse files Browse the repository at this point in the history
  • Loading branch information
rexa222 committed Apr 10, 2023
1 parent b94f39a commit a77114a
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,48 @@

# arabic2latin

Convert Arabic characters to their Latin (English) homophone.


## Installation

Install from source:

```bash
pip install git+https://github.com/rexa222/arabic2latin
```
Alternatively, install from PyPI:
```bash
pip install arabic2latin
```
## Usage/Examples

```python
from arabic2latin import arabic_to_latin

arabic_text = "السَّلَامُ عَلَيْكَ"
converted_text = arabic_to_latin(arabic_text)

print(converted_text)
```
Output:
```text
alsaalaamo aalayka
```
## Debug Mode
If you came across a character that was not converted, you can find it using debug feature and report it as guided in the contributing section.
```text
converted_text = arabic_to_latin(arabic_text, debug=True)
```
Output:
```text
unknown character: ?
```




## Contributing

If you find a bug 🐛, please open a [bug report](https://github.com/rexa222/arabic2latin/issues/new?assignees=&labels=bug&template=bug_report.md&title=). If you have an idea for an improvement or new feature 🚀, please open a [feature request](https://github.com/rexa222/arabic2latin/issues/new?assignees=&labels=Feature+request&template=feature_request.md&title=).

0 comments on commit a77114a

Please sign in to comment.