node-telnet-client/README.md
Hammer1279 a67fa0eead
All checks were successful
Node.js CI / build (x64, linux) (push) Successful in 35s
Node.js CI / build (x64, win) (push) Successful in 34s
Update README for installation instructions and enhance index.js with command-line arguments support
Signed-off-by: Hammer1279 <hammer@ht-dev.de>
2025-01-19 16:54:28 +01:00

14 lines
766 B
Markdown

# node-telnet-client [![Node.js CI](https://github.com/Hammer1279/node-telnet-client/actions/workflows/pkg.yml/badge.svg)](https://github.com/Hammer1279/node-telnet-client/actions/workflows/pkg.yml)
To be used with HTDev BBS Server for encrypted communication and extended functionality.
## Installation
Just download the latest binary for your operating system from the releases page for the last stable version.
For experimental versions, check the pre-releases under releases, for "nightly" builds, check the actions for the latest build artifacts, they build for every commit.
## Run from Source
It has zero dependencies itself so to run a copy locally, just run it with `node index.js`
To build the application, run `npm install` and then `npm run build`.