romaji-to-kana-ng/README.md

Angular module providing a pipe for converting romaji to kana

# RomajiToKanaNg
Provides an angular pipe for converting roman characters to kana.

# Developer Usage
Installation
`npm install --save romaji-to-kana`

Import the module
```typescript
import { RomajiToKanaModule } from 'romaji-to-kana';

@ngModule(
    ...
    imports: [
        ...
        RomajiToKanaModule
    ]
)
```

Usage with ngModel
```html
<input [ngModel]="value | romajiToKana" (ngModelChange)="value=$event" type="text"/>
```

# Enduser Usage
Input your romaji phonetically. Capitals will be converted to katakana whereas lowercase is converted to hiragana.  Mixed case will be ignored.
'-' hyphens will be converted to katakana long vowels. Example: ka -> か　gyo -> ぎょ　gga -> っが.