<commit_before>
# What is RealBay?

RealBay is a tool for browsing torrents.

# What is RealBay CLI?

These are the Command Line Interface (CLI) to the tools. Maybe
one day there will be a `librealbay` but for now this small C
toolset can be used to build and search realbay indexes.

# Building from Source

You can build this from source simply by using `make`, which the
`Makefile` was made by a human should be simple. If none of that makes
sense to you, try this:

    git clone https://github.com/realbay/realbay-cli
    cd realbay-cli
    make

You only need `gcc` to make this from source code. It can be compiled
most anywhere with most any C compiler and has no external dependencies
besides `libc` (for `fopen()` etc.)

# How do I create a new index?

Making a new index is done using the `createindex` command:

    realbay createindex myfile.csv myindex.tordex

Here there are two files:

 * `myfile.csv` is a CSV file that should be separated by pipes
 * `myindex.tordex` is where to write the index

The generated index file is binary and will be 64 bytes for every
line in the CSV file.
<commit_msg>Slight README adjustments.<commit_after>
## What is RealBay?

RealBay is a tool for browsing torrents.

## What is RealBay CLI?

These are the Command Line Interface (CLI) to the tools. Maybe
one day there will be a `librealbay` but for now this small C
toolset can be used to build and search realbay indexes.

## Building from Source

You can build this from source simply by using `make`, which the
`Makefile` was made by a human should be simple. If none of that makes
sense to you, try this:

    git clone https://github.com/realbay/realbay-cli
    cd realbay-cli
    make

You only need `gcc` to make this from source code. It can be compiled
most anywhere with most any C compiler and has no external dependencies
besides `libc` (for `fopen()` etc.)

## How do I create a new index?

Making a new index is done using the `createindex` command:

    realbay createindex myfile.csv myindex.tordex

Here there are two files:

 * `myfile.csv` is a CSV file that should be separated by pipes
 * `myindex.tordex` is where to write the index

The generated index file is binary and will be 64 bytes for every
line in the CSV file.

{'fraction_non_alphanumeric': 0.05380972879896685, 'fraction_numerical': 0.0017219113215669393, 'mean_word_length': 3.1949458483754514, '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': '6085875', 'n_tokens_mistral': 742, 'n_tokens_neox': 647, 'n_words': 366}