# inkferro-napi
Node-API ([napi-rs](https://napi.rs)) bridge exposing the
[inkferro](https://github.com/metaphorics/inkferro) Rust renderer to the `inkferro`
npm package — a byte-for-byte drop-in for the
[ink](https://github.com/vadimdemedes/ink) terminal UI library.
This crate is a `cdylib`: it compiles to a native Node addon (`.node`) that wraps
[`inkferro-core`](https://crates.io/crates/inkferro-core) and
[`inkferro-rt`](https://crates.io/crates/inkferro-rt) behind the FFI boundary the
JavaScript reconciler calls into. It is **not** a general-purpose Rust library —
there is no `rlib`. Consume the renderer from JavaScript via the
[`inkferro`](https://www.npmjs.com/package/inkferro) npm package, or use
`inkferro-core` / `inkferro-rt` directly from Rust.
## Status
`0.1.x`, early release. Built and consumed as the native backend of the `inkferro`
npm package.
## License
Licensed under either of MIT or Apache-2.0 at your option.