# template-rust-library
[](https://github.com/flowscripter/template-rust-library/releases)
[](https://github.com/flowscripter/template-rust-library/actions/workflows/release-rust-library.yml)
[](https://codecov.io/gh/flowscripter/template-rust-library)
[](https://deps.rs/crate/flowscripter_template_rust_library)
[](https://docs.rs/flowscripter_template_rust_library)
[](https://github.com/flowscripter/template-rust-library/blob/main/LICENSE)
> Project template for a Rust library
## Project Template Usage
1. Use as a
[template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
to create a new repository.
2. Update links and references in `README.md`.
## Cargo Crate Usage
```toml
[dependencies]
flowscripter_template_rust_library = "^1"
```
## Development
Build: `cargo build`
Test: `cargo test`
Lint: `cargo fmt`
## Documentation
### Overview
Sample mermaid diagram to test rendering in markdown:
```mermaid
classDiagram
Foo <|-- Bar
```
### API
Link to auto-generated API docs:
[API Documentation](https://docs.rs/flowscripter_template_rust_library)
## License
MIT © Flowscripter