README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# Rust Crate Template

[![crates.io](https://img.shields.io/crates/v/rust-crate-template.svg)](https://crates.io/crates/rust-crate-template)
[![docs.rs](https://docs.rs/rust-crate-template/badge.svg)](https://docs.rs/rust-crate-template)
[![github.com](https://github.com/Fuwn/rust-crate-template/actions/workflows/check.yaml/badge.svg?branch=main)](https://github.com/Fuwn/rust-crate-template/actions/workflows/check.yaml)

Rust Crate Template is a Rust crate template.

## Usage

> Using this as a template? Try
> `cargo generate --git https://github.com/Fuwn/rust-crate-template` with
> [`cargo-generate`](https://github.com/cargo-generate/cargo-generate)!

### Add Rust Crate Template as a dependency

```toml
# Cargo.toml

[dependencies]
rust-crate-template = "0.1.1"
```

## Examples

Examples can be found within the
[`examples/`](https://github.com/Fuwn/rust-crate-template/tree/main/examples) directory.

## License

This project is licensed with the
[GNU General Public License v3.0](https://github.com/Fuwn/rust-crate-template/blob/main/LICENSE).