Merge branch 'main' of regithub.com:a5-stable/kakari_musubi

a5-stable · Jan 22, 2022 · fc0a4c5 · fc0a4c5
2 parents 1925599 + 17fefb5
commit fc0a4c5
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -22,7 +22,17 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+** Now we can do is very limited. Any contribution would be GREATLY appreciated. **
+
+### is_km?
+return true if given sentence includes KakariMusubi particles.
+
+```
+KakariMusubi.is_km?("雨こそ降る")
+
+# => true
+```
+
 
 ## Development