Merge pull request #115 from instaclustr/add-getting-started

issue-100, getting started information was added

README.md

@@ -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