# zmodem-ts

[中文](README.cn.md) | [English](README.md)

> ⚠️ **Note:** If you're looking for a more solid and actively maintained ZModem solution for JavaScript/TypeScript, please use [zmodem2-js](https://github.com/zxdong262/zmodem2-js) instead. zmodem2-js is a port of the zmodem2 Rust crate and provides better performance and reliability.

It is a ts fork of [https://github.com/FGasper/zmodemjs](https://github.com/FGasper/zmodemjs).

Just rewrite with ts(except for browser.js), provide a more modern code base for users,  should gain a little bit performance.

Ignore some errors instead of throw them, to avoid some app crash issues.

## Installation

### Node.js

```bash
npm i -D zmodem-ts
```

## Usage example code

Check the [examples](./examples) folder. Or just check how to use [https://github.com/FGasper/zmodemjs](https://github.com/FGasper/zmodemjs) since no API differences.

## Demo

Check out the complete demo project: [zmodem-ts-demo](https://github.com/zxdong262/zmodem-ts-demo)

## Todos

- Add more tests
- Add more examples
- Improve the code quality

## License

MIT