<commit_before>warren
=====

A Java IRC framework. Still very much in development.

# Why?

* Personal interest,
 * Implementing a protocol,
 * Getting better at testing,
 * Producing a framework,
 * Testing a framework,
 * Scope for both simple and complex goals.
* Personal use,
 * Twitch bots,
 * GitHub helper bots.
* Fun.

# Usage

TBD.

There is no run target, it is a library. See the building instructions.

# TODO

[RFC 2812](https://tools.ietf.org/html/rfc2812)

* Server Connection cleanup / separation,
* ~~Combine incoming and outgoing messages~~,
* ~~NickServ / password / file?~~,
* ~~High level events, not protocol dependent (channel message, PM, join, leave, etc)~~,
 * Expand events support
* Add concept of "acceptable next commands" for use in MOTD parsing, etc
* Consider splitting message validators out (shouldn't be instance specific),
* ~~Logging framework (chose SLF4J),~~<commit_msg>Small README language tweaks<commit_after>warren
=====

A Java IRC framework for personal use (but open-sourced).

# Why?

* Personal interest,
 * Implementing a protocol,
 * Getting better at testing,
 * Producing a framework,
 * Testing a framework,
 * Scope for both simple and complex goals.
* Personal use,
 * Twitch bots,
 * GitHub helper bots.
* Fun.

# TODO

[RFC 2812](https://tools.ietf.org/html/rfc2812)

* Server Connection cleanup / separation,
* ~~Combine incoming and outgoing messages~~,
* ~~NickServ / password / file?~~,
* ~~High level events, not protocol dependent (channel message, PM, join, leave, etc)~~,
 * Expand events support
* Add concept of "acceptable next commands" for use in MOTD parsing, etc
* Consider splitting message validators out (shouldn't be instance specific),
* ~~Logging framework (chose SLF4J),~~
{'fraction_non_alphanumeric': 0.11009697661152311, 'fraction_numerical': 0.01026811180832858, 'mean_word_length': 4.48125, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5021963', 'n_tokens_mistral': 540, 'n_tokens_neox': 517, 'n_words': 209}