Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue-100, getting started information was added #115

Merged
merged 2 commits into from
Sep 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 43 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,59 @@ BRRO Compressor is a compressor that relies on the characteristics of a signal t

For a detailed description on the compressor methods and logic check `BRRO.md`.

## Usage
## Getting Started with BRRO Compressor

### Prerequisites

- Ensure you have [Rust](https://www.rust-lang.org/tools/install) and Cargo installed on your system.

### Installation

1. Clone the repository:
```bash
git clone https://github.com/instaclustr/fft-compression
cd fft-compression
```

2. Build the project:
```bash
cargo build --release
```

### Usage

Currently BRRO relies on have Raw BRRO files generated by our prometheus remote endpoint. This would work as input for the compressor.

Compressor usage:

```An Advanced Time-Series Compressor

```
Usage: brro-compressor [OPTIONS] <INPUT>

Arguments:
<INPUT> input file
<INPUT> input file

Options:
--compressor <COMPRESSOR> [default: auto] [possible values: auto, noop, fft, wavelet, constant, polynomial, top-bottom]
-u Uncompresses the input file/directory
-h, --help Print help
-V, --version Print version
```
--compressor <COMPRESSOR> [default: auto] [possible values: auto, fft, constant, polynomial]
-u Uncompresses the input file/directory
-h, --help Print help
-V, --version Print version
```

#### Compress a File

To compress a file using the BRRO Compressor, run:

```bash
brro-compressor <input-file>
```

#### Decompress a File

To decompress a file, use the following command:

```bash
brro-compressor -u <input-file>
```

## Programs and description

Expand Down
Loading