Skip to content

Commit

Permalink
v1.0.0
Browse files Browse the repository at this point in the history
brunobord committed Apr 30, 2021
1 parent 3d43247 commit ee5d37d
Showing 2 changed files with 27 additions and 0 deletions.
25 changes: 25 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# ncat-chat changelog

## v1.0.0

This is the first release of ncat-chat. And probably the only one, let's be honest.

This tool is a minimalist chat server/client using `ncat`.

There are two bash scripts: `ncat-server.sh` & `ncat-client.sh`, although they could probably be portable for another shell.

As expected, the server script open a server, waiting for connections. And the client connects to the server, enabling discussion. Please see the `README.md` file for basic and advanced usage.

### BIG DISCLAIMER

**THIS SOLUTION IS BY NO MEAN PRODUCTION-SAFE. IT'S A TOY.**

### Basic features

* Server and client scripts use SSL by default.
* Customization / configuration via environment variables
* Server configuration: listening port.
* Client configuration: server hostname, port, username, color.
* Usage help available via `./ncat-server -h` or `./ncat-client.sh -h`
* Compatible with `rlwrap` if you want to use the arrow keys to edit your message, browse your history, etc.
* Thorough documentation in the `README.md` file for further details on usage and options.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# netcat-based chat

[![GitHub release](https://img.shields.io/github/release/brunobord/ncat-chat)](https://github.com/brunobord/ncat-chat/releases/)

Did you know that you could run a chat service using only `netcat`/`ncat`?

## BIG DISCLAIMER

0 comments on commit ee5d37d

Please sign in to comment.