# webcface-js
[![coverage](https://raw.githubusercontent.com/na-trium-144/webcface-js/badge/coverage.svg)](https://github.com/na-trium-144/webcface-js/actions/workflows/node.js.coverage.yml)
[![npm](https://img.shields.io/npm/v/webcface)](https://www.npmjs.com/package/webcface)

Client library of [WebCFace](https://github.com/na-trium-144/webcface) for JavaScript and TypeScript.
Runs on Node.js and browser.

Please refer to the WebCFace repository for how to use it.
To use this library, you need WebCFace server separately.

## Installation

```bash
npm install webcface
```

Since ver1.7, you can also load webcface library built with webpack from CDN:
```html
<script src="https://cdn.jsdelivr.net/npm/webcface@1.12.0/dist/webcface.bundle.js"></script>
```

## API Documentation
[API Reference](https://na-trium-144.github.io/webcface-js/modules.html)

See also [WebCFace documentation](https://na-trium-144.github.io/webcface/)(Currently Japanese only).