/bbs-file-transfer

Node.js library for legacy file transfer protocols

Primary LanguageJavaScriptBSD 2-Clause "Simplified" LicenseBSD-2-Clause

bbs-file-transfer

Overview

bbs-file-transfer is a Node.js library designed to provide file transfer functionality with X-Modem, Y-Modem, and Z-Modem protocols, along with popular varients.

Documentation

Documentation (via jsdoc) can be found at: Documentation

Requirements

  • Node.js (currently tested with versions 18.x and 20.x).

Installation

Install the package via npm:

npm install bbs-file-transfer

Usage

Here's a simple example with the file interface to get you started:

Contributing

We welcome contributions! Please see the CONTRIBUTING.md file for details on how to contribute to the development of bbs-file-transfer.

License

This project is licensed under the BSD 2-clause license. See the LICENSE file for details.