# Rust Lib - Template

[![crates.io][crate-image]][crate-link]
![MSRV][msrv-image]
[![Documentation][doc-image]][doc-link]
[![LICENSE][license-image]][license-link]
[![codecov][codecov-image]][codecov-link]
[![Build Status][build-image]][build-link]
[![dependency status][deps-image]][deps-link]
![downloads][downloads-image]

## Prerequisites

```sh
rustup component add clippy
rustup component add rustfmt

# Debugging & Code-Coverage
rustup component add llvm-tools
```

## Commands

Cargo alias commands

```sh
# .cargo/config.toml [alias]
cargo lint
cargo format
```

The `docs` Auto-Generate script is `docs.sh`.

[//]: # "badges"
[crate-image]: https://img.shields.io/crates/v/rust-lib-template?label=latest
[crate-link]: https://crates.io/crates/rust-lib-template
[doc-image]: https://img.shields.io/docsrs/rust-lib-template
[doc-link]: https://docs.rs/rust-lib-template
[msrv-image]: https://img.shields.io/badge/rustc-1.68+-blue.svg
[build-image]: https://github.com/vhidvz/rust-lib-template/actions/workflows/ci.yml/badge.svg
[build-link]: https://github.com/vhidvz/rust-lib-template/actions/workflows/ci.yml
[license-image]: https://img.shields.io/github/license/vhidvz/workflow-js?style=flat
[license-link]: https://github.com/vhidvz/workflow-js/blob/master/LICENSE
[codecov-image]: https://raw.githubusercontent.com/vhidvz/rust-lib-template/main/docs/coverage/badges/flat.svg
[codecov-link]: https://htmlpreview.github.io/?https://github.com/vhidvz/rust-lib-template/blob/main/docs/coverage/index.html
[deps-image]: https://deps.rs/repo/github/vhidvz/rust-lib-template/status.svg
[deps-link]: https://deps.rs/repo/github/vhidvz/rust-lib-template
[downloads-image]: https://img.shields.io/crates/d/rust-lib-template.svg