# pzzld

[![crates.io](https://img.shields.io/crates/v/pzzld.svg)](https://crates.io/crates/pzzld)
[![docs.rs](https://docs.rs/pzzld/badge.svg)](https://docs.rs/pzzld)
[![license](https://img.shields.io/crates/l/pzzld.svg)](https://crates.io/crates/pzzld)

[![clippy](https://github.com/FL03/pzzld/actions/workflows/clippy.yml/badge.svg)](https://github.com/FL03/pzzld/actions/workflows/clippy.yml)
[![rust](https://github.com/FL03/pzzld/actions/workflows/rust.yml/badge.svg)](https://github.com/FL03/pzzld/actions/workflows/rust.yml)

***

_**The library is currently in the early stages of development and is not yet ready for production use.**_

A full-stack platform

## Features

- [x] Feature 1

## Getting Started

### Building from the source

Start by cloning the repository

```bash
git clone https://github.com/FL03/pzzld.git
cd pzzld
```

#### _Building the project_

```bash
cargo build --all-features -r -v --workspace
```

#### _Running tests_

```bash
cargo test --all-features -r -v --workspace
```

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies.pzzld]
features = []
version = "0.1.0"
```

### Examples

#### _Basic Usage_

```rust
    extern crate pzzld;

    fn main() -> Result<(), Box<dyn std::error::Error>> {
        tracing_subscriber::fmt::init();
        tracing::info!("Welcome to {name}", name = pzzld);


        Ok(())
    }
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.