Skip to content

Commit 09baef9

Browse files
committed
Readme improvements
1 parent df584f5 commit 09baef9

File tree

1 file changed

+42
-28
lines changed

1 file changed

+42
-28
lines changed

README.md

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This library is written in Kotlin, but it can be used from Java.
1111

1212
Visit the [website][wanakana-website] to see WanaKana in action (JS version).
1313

14+
Or use the demo Android app included in this repository: `./gradlew demo:installDebug`.
15+
1416
## Usage
1517

1618
```
@@ -32,40 +34,23 @@ The artifacts are available on mavenCentral, make sure that your buildscript rep
3234

3335
## Quick Reference
3436

37+
### Android bindings
38+
3539
```kotlin
36-
/*** ANDROID BINDINGS ***/
3740
// Automatically converts text using a TextWatcher.
3841
// Uses `toKanaIme()` as converter by default
3942
val binding = WanakanaAndroid.bind(editText)
4043

41-
// Removes the TextWatcher.
42-
binding.clear()
43-
44-
/*** TEXT CHECKING UTILITIES ***/
45-
// Available for both Char and String.
46-
// Extensions functions are also available.
47-
48-
Wanakana.isJapanese("泣き虫。!〜2¥zenkaku")
49-
// => true
50-
51-
Wanakana.isKana("あーア")
52-
// => true
53-
54-
Wanakana.isHiragana("すげー")
55-
// => true
56-
57-
Wanakana.isKatakana("ゲーム")
58-
// => true
59-
60-
Wanakana.isKanji("切腹")
61-
// => true
62-
Wanakana.isKanji("勢い")
63-
// => false
44+
// Adds a listener for text updates.
45+
binding.addListener(initialize = true) { convertedText -> /* Do something. */ }
6446

65-
Wanakana.isRomaji("Tōkyō and Ōsaka")
66-
// => true
47+
// Turns off the conversion.
48+
// Not needed for cleanup, you can ignore the binding safely.
49+
binding.clear()
50+
```
6751

68-
/*** TEXT CONVERSION ***/
52+
### Text conversion
53+
```kotlin
6954
Wanakana.toKana("ONAJI buttsuuji")
7055
// => "オナジ ぶっつうじ"
7156
Wanakana.toKana("座禅‘zazen’スタイル")
@@ -91,8 +76,37 @@ Wanakana.toRomaji("ひらがな カタカナ")
9176
// => "hiragana katakana"
9277
Wanakana.toRomaji("ひらがな カタカナ", upcaseKatakana = true)
9378
// => "hiragana KATAKANA"
79+
```
80+
81+
### Text checking utilities
82+
83+
```kotlin
84+
// Available for both Char and String.
85+
// Extensions functions are also available.
86+
87+
Wanakana.isJapanese("泣き虫。!〜2¥zenkaku")
88+
// => true
89+
90+
Wanakana.isKana("あーア")
91+
// => true
92+
93+
Wanakana.isHiragana("すげー")
94+
// => true
95+
96+
Wanakana.isKatakana("ゲーム")
97+
// => true
98+
99+
Wanakana.isKanji("切腹")
100+
// => true
101+
Wanakana.isKanji("勢い")
102+
// => false
94103

95-
/*** EXTRA UTILITIES ***/
104+
Wanakana.isRomaji("Tōkyō and Ōsaka")
105+
// => true
106+
```
107+
108+
### Extra utilities
109+
```kotlin
96110
Wanakana.stripOkurigana("お祝い")
97111
// => "お祝"
98112
Wanakana.stripOkurigana("踏み込む")

0 commit comments

Comments
 (0)