Skip to content

Commit

Permalink
Add installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Ilkyu Ju committed Aug 3, 2020
1 parent e7d1463 commit 09cc6da
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,16 @@ It currently follows the [Revised Romanization of Korean](https://www.korean.go.

## Usage

### Installation
```bash
pip install korean_romanizer
```

### Basic Usage
```python
from korean_romanizer.romanizer import Romanizer

r = Romanizer("안녕하세요")
r.romanize() # outputs 'annyeonghaseyo'
r.romanize()
# returns 'annyeonghaseyo'
```

0 comments on commit 09cc6da

Please sign in to comment.