Cedict Dictionary

---

GitHub Workflow

---

The Cedict Dictionary was created to use the Chinese dictionary easily.

With this library, you can use the many methods to search :

1. Chinese character
2. Simplified Chinese character
3. Intonation in "Pinyin"
4. English traduction

Or you can simply create tour own methods with the Cedict JSON file which will be updated every time a new version of the Cedict appear.

To know more about the Cedict, go on this page.

Table of Contents

• Table of Contents
• Getting Started
  • Cedict
  • Next features
• Contributing
  • Code of Conduct
  • Contributing Guide

Getting Started

First to use the library, you should use this command into your project :

npm i @tykok/cedict-dictionary

Cedict

How to use the Cedict class in your project ? Simple, you just need to import it where you want with :

import Cedict from '@tykok/cedict-dictionary'

Next, you can use some static functions like :

Cedict.getByPinyin('ni3')

To know all about this class, go on the documentation.

Next features

Maybe, I'll:

• Implement a CLI command for Cedict.
• Implement a Cedict database generation.

Contributing

Development happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.

Read below to learn how you can take part in improving this Cedict Dictionary.

Code of Conduct

We adopted a Code of Conduct that we expect Cedict Dictionary participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to our Cedict Dictionary.