Skip to content

Getting started

To use buzzrs inside your Rust project, you need to add it first. There are several ways to add it.

The crate is published on crates.io for easy usage.

Terminal window
cargo add buzzrs
Terminal window
cargo add --git https://github.com/philxws692/buzzrs

First you need to clone the repository to a local path:

Terminal window
git clone git@github.com:philxws692/buzzrs.git

Then you need to add it to your project

Terminal window
cargo add --path path/to/buzzrs

Assume the following structure

  • Directorybuzzrs/
  • Directoryawesome-project
    • Directorysrc
      • main.rs
    • Cargo.toml

Inside your awesome-project directory you would need to use the following path:

Terminal window
cargo add --path ../buzzrs

Thats it! Now you can use buzzrs inside of your project.