Skip to content

Commit

Permalink
Better README header with better badges
Browse files Browse the repository at this point in the history
  • Loading branch information
mwhirls authored Feb 8, 2024
1 parent 7ed827b commit 1458eb4
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![experimental](http://badges.github.io/stability-badges/dist/experimental.svg)](http://github.com/badges/stability-badges)
<div align="center">
<h1>bunsetsu</h1>
</div>
<p align="center">
A wrapper library around <a href="https://github.com/takuyaa/kuromoji.js">kuromoji</a> that intelligently groups Japanese morphemes into words
</p>
<div align="center">
<a href="https://github.com/mwhirls/jimakun/actions"><img src="https://img.shields.io/github/actions/workflow/status/mwhirls/jimakun/build.yml?branch=main" alt="Build Status"></a>
<a href="https://github.com/mwhirls/bunsetsu/blob/main/LICENSE.txt"><img alt="GitHub License" src="https://img.shields.io/github/license/mwhirls/bunsetsu"></a>
<img alt="Static Badge" src="https://img.shields.io/badge/stability-experimental-yellow?style=flat">
</div>

# bunsetsu
A wrapper library around [kuromoji](https://github.com/takuyaa/kuromoji.js) that intelligently groups Japanese morphemes into words
## About

Kuromoji and other morphological parsers tokenize Japanese sentences into morphemes, which may or may not correspond to what we typically think of as word unit. This means that conjugations of a verb are typically parsed as multiple tokens separate from the stem-form of the word. For example, the te-form of a verb, such as 食べる (taberu), is parsed as 食べ and て instead of together as 食べて.

Expand Down Expand Up @@ -54,4 +62,4 @@ bunsetsu is licensed under the MIT license.

### Kuromoji

This project uses [kuromoji](https://github.com/takuyaa/kuromoji.js), which is licensed under the Apache 2.0 license.
This project uses [kuromoji](https://github.com/takuyaa/kuromoji.js), which is licensed under the Apache 2.0 license.

0 comments on commit 1458eb4

Please sign in to comment.