korean-dictionary/README.md

Provides Korean Dictionary Implements and Crawler for Node.js with Rust FFI

# KoreanDictionary

> Provides Korean Dictionary Implements and Dictionary Crawler for Node.js with Rust FFI

[![npm](https://img.shields.io/npm/v/korean-dictionary.svg?style=for-the-badge)](https://www.npmjs.com/package/korean-dictionary) [![npm](https://img.shields.io/npm/dt/korean-dictionary.svg?style=for-the-badge)](https://www.npmjs.com/package/korean-dictionary)

## ChangeLog

See [CHANGELOG](./CHANGELOG.md)

## Installation

- Install with npm:

```bash
npm install korean-dictionary --save
```

- Clone the repo:

```bash
git clone https://github.com/Astro36/KoreanDictionary.git
```

## Requirement

To use this program, you need to install [Rust](https://www.rust-lang.org/).

Then you run below command to compile the program.

```bash
cargo build --release
```

## Usage

### API Documentation

See [API](https://astro36.github.io/KoreanDictionary/index.html)

### Example

Crawl [National Institute of Korean Language](http://www.korean.go.kr/) [Korean Dictionary](http://stdweb2.korean.go.kr/main.jsp) in parallel using 16 threads, and save it as [TSV](https://en.wikipedia.org/wiki/Tab-separated_values) file.

```javascript
const { Dictionary } = require('korean-dictionary');
const dictionary = Dictionary.createFromWeb(16);
dictionary.saveAsTsv('./dictionary.tsv');
```

## License

```text
Copyright (c) 2018 Seungjae Park

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

KoreanDictionary is licensed under the [MIT License](./LICENSE).