diff --git a/Cargo.lock b/Cargo.lock index 732072d..70396ff 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -265,7 +265,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0ceec5bc11778974d1bcb055b18002eba7f4b3518b6a0081b3af5f21666da9ad" [[package]] -name = "matrix-rain" +name = "matrixfall" version = "0.3.0" dependencies = [ "clap", diff --git a/Cargo.toml b/Cargo.toml index aae6456..89f615c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,11 @@ [package] -name = "matrix-rain" +name = "matrixfall" version = "0.3.0" -description = "The matrix-rain effect in the terminal" +description = "The matrixfall effect in the terminal" authors = ["Shresht7"] -repository = "https://github.com/Shresht7/matrix-rain" +repository = "https://github.com/Shresht7/matrixfall" license = "MIT" -keywords = ["cli", "command-line-utilities", "matrix-rain"] +keywords = ["cli", "command-line-utilities", "matrixfall"] categories = ["command-line-utilities"] edition = "2024" diff --git a/README.md b/README.md index 92594f2..e8da003 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -# Matrix-Rain -------------- +# `matrixfall` -The matrix-rain effect in the terminal. +The matrixfall effect in the terminal. ![demo](./demo.gif) @@ -23,13 +22,13 @@ The matrix-rain effect in the terminal. > [!NOTE] > -> To install and run Matrix-Rain, you will need to have Rust and Cargo installed on your system. You can install Rust and Cargo by following the instructions at [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install). +> To install and run matrixfall, you will need to have Rust and Cargo installed on your system. You can install Rust and Cargo by following the instructions at [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install). You can clone the repository and build the project: ```sh -git clone https://github.com/Shresht7/matrix-rain.git -cd matrix-rain +git clone https://github.com/Shresht7/matrixfall.git +cd matrixfall cargo build --release ``` @@ -39,44 +38,44 @@ To run the project, use the following command: cargo run --release ``` -Or **alternatively**, you can also install `Matrix-Rain` using `cargo install` and add it to your `$PATH` variable for easy access: +Or **alternatively**, you can also install `matrixfall` using `cargo install` and add it to your `$PATH` variable for easy access: ```sh -cargo install --path . --name matrix-rain +cargo install --path . --name matrixfall ``` -After installation, you can run Matrix-Rain from anywhere by adding the Cargo bin directory to your `$PATH` variable. +After installation, you can run matrixfall from anywhere by adding the Cargo bin directory to your `$PATH` variable. --- ## 📖 Usage Instructions -To use Matrix-Rain, you can run the project with the following command: +To use matrixfall, you can run the project with the following command: ```sh -matrix-rain [OPTIONS] +matrixfall [OPTIONS] ``` Here are some examples of how to use the different configuration options: - To use the original Katakana symbols with the default settings: ```sh - matrix-rain + matrixfall ``` - To use binary symbols with a custom stream color and gradient: ```sh - matrix-rain --mode binary --stream-color 0,255,70 --stream-color-gradient-factor 0.5 + matrixfall --mode binary --stream-color 0,255,70 --stream-color-gradient-factor 0.5 ``` - To use ASCII characters with a higher frame rate and leave a trail: ```sh - matrix-rain --mode ASCII --fps 120 --leave-trail + matrixfall --mode ASCII --fps 120 --leave-trail ``` > [!TIP] > -> You can combine multiple options to customize the matrix-rain effect to your liking. +> You can combine multiple options to customize the matrixfall effect to your liking. ### Configuration Options diff --git a/src/main.rs b/src/main.rs index 33381b2..8200d24 100644 --- a/src/main.rs +++ b/src/main.rs @@ -48,7 +48,7 @@ fn run(config: &config::Config) -> std::io::Result<()> { // Setup the Matrix renderer matrix.setup(config, &mut stdout)?; - // Render the Matrix-Rain on screen + // Render the matrixfall on screen loop { // Render each stream matrix.render(config, &mut stdout)?;