# Async NNG-rs

This crate provides wrapper types that leverage the
[`nng-rs`](https://gitlab.com/neachdainn/nng-rs/) crate to provide async-await operations on NNG
sockets.

## Getting Started

The library can be added to your project via cargo:

```bash
$ cargo add async-nng
```

From there, you'll want to look at the [Rust docs](https://docs.rs/async-nng/latest/async-nng/) for
more information on how to use the library.

## Development

If you're looking to add a test or feature to the library, please be aware of the following:

-   This project makes extensive use of `clippy` and does not generally allow lint warnings or
    errors within the codebase.
-   All files must be formatted with rustfmt (default settings) before being saved / committed.
-   We have a very strict commit style. See the [contributing document](./CONTRIBUTING.md) for more
    information.

## License

This crate and associated code are shipped under the MIT license, to match the license used by the
`nng-rs` crate.

```
Copyright (c) 2024 Jeremy Steward

Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
```