Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mwhirls authored Feb 8, 2024
1 parent 41b6a78 commit eed5d6b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<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
A wrapper library written in Typescript 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/bunsetsu/actions"><img src="https://img.shields.io/github/actions/workflow/status/mwhirls/bunsetsu/build.yml?branch=main" alt="Build Status"></a>
Expand All @@ -28,6 +28,9 @@ This library builds on top of kuromoji to group the morphemes it produces into f

See the test cases under '/test/' to get a sense of the types of tokens bunsetsu groups together as a single word unit.

## Support
bunsetsu is ESM library that supports both server and browser.

## Debugging Unit Tests in VSCode

The source code is written in Typescript using ES modules, and the unit tests are written using [MochaJS](https://mochajs.org/). In order to debug the Typescript unit tests, you must run the tests with `ts-node`. Add the following configuration to your `launch.json` file in VSCode to get started:
Expand Down

0 comments on commit eed5d6b

Please sign in to comment.