Skip to content

Commit 665a590

Browse files
committed
update readme
1 parent a61a2d2 commit 665a590

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,26 @@ Converts Greek Beta Code to Greek characters and vice versa.
66

77
`pip install beta-code`
88

9+
(See project on [PyPI](https://pypi.org/project/beta-code/))
10+
911
## Usage
1012

1113
```python
1214
import beta_code
1315

14-
beta_code.greek_to_beta_code('χαῖρε ὦ κόσμε')
16+
beta_code.greek_to_beta_code(u'χαῖρε ὦ κόσμε')
1517
# => 'xai=re w)= ko/sme'
1618

17-
beta_code.beta_code_to_greek('mh=nin a)/eide qea\\ *phlhi+a/dew *)axilh=os')
19+
beta_code.beta_code_to_greek(u'mh=nin a)/eide qea\\ *phlhi+a/dew *)axilh=os')
1820
# => 'μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος'
1921
```
2022

21-
(See project on [PyPI](https://pypi.org/project/beta-code/))
23+
### With additional mappings
24+
25+
```python
26+
beta_code.beta_code_to_greek(u'f2a/nac', custom_map={ u'f2': u'ϝ' })
27+
# => 'ϝάναξ'
28+
```
2229

2330
## Tests
2431

0 commit comments

Comments
 (0)