Skip to content

README.md

Latest commit

 

History

History
45 lines (30 loc) · 1.42 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.42 KB

Dispatcharr-cli

A cli tool for downloading VODs off of Dispatcharr VOD downloading functionality.

Warning

This software is currently in alpha stages, there may be bugs and breaking changes to the API.

Features

  • Download full series
  • Manually pick and exclude seasons and episodes
  • VOD validation after download

Usage

// TODO: ...

Contributing

Contributions are welcome.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-change)
  3. Make your changes and ensure everything compiles (cargo build)
  4. Run tests (cargo test)
  5. Run the linter (cargo clippy)
  6. Format your code (cargo +nightly fmt from rustfmt)
  7. Open a pull request with a clear description of what you changed and why

Guidelines

  • Keep the cli user-friendly and well-documented
  • Prefer returning Result types over panicking
  • New dependencies should be justified since the core functionality resides in Core

Third-Party Libraries

Crate Version License Purpose
colored 3.1.1 MPL 2.0 Coloured printing
chrono 0.4 MIT / Apache-2.0 Timestamp handling

License

This project is licensed under the GNU General Public License v2.0. See LICENSE for the full license text.