<commit_before># tkellem

tkellem is an IRC bouncer, a proxy that keeps you permanently logged on to an
IRC server and stores all messages so that when your client next connects, you
can see the backlog of what happened while you were gone.

tkellem supports multiple users, multiple device-independent backlogs
per-user, and connecting to multiple IRC servers all from the same
process.

## IMPORTANT

This is still a pretty early alpha. Expect bugs and missing
functionality.

## Getting Started

This will have to do as a quickstart guide, for now:

    $ git clone git://github.com/codekitchen/tkellem.git
    $ cd tkellem
    $ bundle install
    $ bundle exec bin/tkellem start
    $ bundle exec bin/tkellem admin
    > help
    > listen ircs://0.0.0.0:8765
    > user --add <my-name> --admin
    > password --user <my-name> <<PASSWORD>>
    > network --add --public freenode ircs://irc.freenode.org:7000

Then connect to tkellem with an irc client:

    server: localhost
    port: 8765
    ssl: yes

    nickname: <my-name>
    login: <my-name>@freenode
    server password: <<PASSWORD>><commit_msg>update readme for gem install<commit_after># tkellem

tkellem is an IRC bouncer, a proxy that keeps you permanently logged on to an
IRC server and stores all messages so that when your client next connects, you
can see the backlog of what happened while you were gone.

tkellem supports multiple users, multiple device-independent backlogs
per-user, and connecting to multiple IRC servers all from the same
process.

## IMPORTANT

This is still a pretty early alpha. Expect bugs and missing
functionality.

## Getting Started

This will have to do as a quickstart guide, for now:

    $ gem install tkellem
    $ tkellem start
    $ tkellem admin
    > help
    > listen ircs://0.0.0.0:8765
    > user --add <my-name> --admin
    > password --user <my-name> <<PASSWORD>>
    > network --add --public freenode ircs://irc.freenode.org:7000

Then connect to tkellem with an irc client:

    server: localhost
    port: 8765
    ssl: yes

    nickname: <my-name>
    login: <my-name>@freenode
    server password: <<PASSWORD>>

Note that all config and log files are stored in ~/.tkellem of the user
you run `tkellem start` as. You also need to run `tkellem admin` as this
same user, in order to have access to the admin console.
{'fraction_non_alphanumeric': 0.0767581475128645, 'fraction_numerical': 0.0137221269296741, 'mean_word_length': 3.2807339449541284, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 29, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, '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': '273829', 'n_tokens_mistral': 730, 'n_tokens_neox': 709, 'n_words': 312}