Skip to content

Commit b26ce56

Browse files
committed
docs: update readme examples
1 parent 2cb36e7 commit b26ce56

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The project is structured as a monorepo which hosts all of the *evolution* frame
1111

1212
## Installation
1313

14-
The easiest way to install a complete *evolution* binary on your system is by using the [Cargo](https://crates.io/) package manager (which downloads it from [this](https://crates.io/crates/evolution) link).
14+
The easiest way to install an *evolution* binary on your system with support for all implemented output targets is by using the [Cargo](https://crates.io/) package manager (which downloads it from [this link](https://crates.io/crates/evolution)). This binary can be found at [examples/full](examples/full) in this repo.
1515

1616
```
1717
cargo install evolution
@@ -29,13 +29,12 @@ cd evolution
2929
cargo build --release
3030
```
3131

32-
If you want to integrate any of the evolution crates in your own project, simply add them as dependencies to your projects Cargo.toml file, for example.
32+
If you want to integrate any of the evolution crates in your own project that you're building, simply add them as dependencies to your projects Cargo.toml file like you would any other third-party dependecy, like below.
3333

3434
```toml
3535
[dependencies]
36-
evolution-common = "1.0.0"
37-
evolution-schema = "1.0.0"
38-
...
36+
evolution-common = "1.2.0"
37+
evolution-schema = "1.2.0"
3938
```
4039

4140

@@ -48,10 +47,10 @@ An example schema can be found [here](https://github.com/firelink-data/evolution
4847

4948
## Quick start
5049

51-
If you install the program as explained above then by simply running the binary you will see the following helpful usage print:
50+
If you install the program as explained above then by simply running the binary you will see the following usage print:
5251

5352
```
54-
🦖 Evolve your fixed-length data files into Apache Parquet, fully parallelized!
53+
Efficiently evolve your old fixed-length data files into modern file formats.
5554
5655
Usage: evolution.exe [OPTIONS] <COMMAND>
5756
@@ -64,7 +63,7 @@ Options:
6463
-N, --n-threads <N_THREADS>
6564
Enable multithreading and set the number of threads (logical cores) to use [default: 1]
6665
-C, --thread-channel-capacity <THREAD_CHANNEL_CAPACITY>
67-
The maximum amount of messages that can be accumulated in the thread channels before holding
66+
The maximum capacity of the thread channel (in number of messages) [default: 32]
6867
-R, --read-buffer-size <READ_BUFFER_SIZE>
6968
The size of the read buffer used when converting (in bytes) [default: 5368709120]
7069
-W, --write-buffer-size <WRITE_BUFFER_SIZE>
@@ -75,12 +74,12 @@ Options:
7574
Print version
7675
```
7776

78-
To specify the log verbosity of the program, set the `RUST_LOG` environment variable to your wanted value, e.g., `INFO` or `DEBUG`.
77+
To specify the log verbosity, set the `RUST_LOG` environment variable to your wanted value, e.g., `INFO` or `DEBUG`.
7978

8079

8180
## Threading
8281

83-
To know how many threads (logical cores) you have available on your system you can use any of the following commands depending on your host system:
82+
To know how many threads (logical cores) you have available on your system you can either of the following commands depending on your host system:
8483

8584
- Windows:
8685
- Command: `Get-WmiObject Win32_Processor | Select-Object Name, NumberOfCores, NumberOfLogicalProcessors`

0 commit comments

Comments
 (0)