Skip to content

README.md

Latest commit

聽

History

History
73 lines (54 loc) 路 2.12 KB

README.md

File metadata and controls

73 lines (54 loc) 路 2.12 KB
Raw

dico-client

npm version npm downloads Github Actions CI Codecov Conventional Commits License

Dico.app Client.

  • 馃攽 聽Use keys seamlessly;
  • 馃帍 聽Fetch your current dico;
  • 馃寪 聽i18n support.

Install

npm install @dico/client

Usage

Update your scripts inside your package.json:

{
    /* ... */
    "scripts": {
        "dev": "dico-fetch && ...",
        "build": "dico-fetch && ..."
    }
}

Init dico client:

import { createDico } from "@dico/client";
// Dico data file is created next to your `dico.config.json` file
import data from "../dico.data.json";

export const { $dico, $dicoI18n } = createDico(data);

Documentation

To discover what's new on this package check out the changelog. For full documentation, visit the official Dico.app documentation.

License

MIT License