<!---
Copyright (C) 2021 Robin Krahl <robin.krahl@ireas.org>
SPDX-License-Identifier: CC0-1.0
-->

# nitrokey3-rs

A Rust library for Nitrokey 3 devices.

This crate provides access to all admin commands available over CTAPHID for
Nitrokey 3 devices with the firmware release v1.0.1 or older.

Please see the [API documentation][docs] for more information.

[docs]: https://docs.rs/nitrokey3

## Contributing

Contributions to this project are welcome!  Please submit patches to the
mailing list [~ireas/nitrokey-rs-dev@lists.sr.ht][] ([archive][]) using the
`[PATCH nitrokey3-rs]` subject prefix.  For more information, see the
[Contributing Guide][].

[~ireas/nitrokey-rs-dev@lists.sr.ht]: mailto:~ireas/nitrokey-rs-dev@lists.sr.ht
[archive]: https://lists.sr.ht/~ireas/nitrokey-rs-dev
[Contributing Guide]: https://man.sr.ht/~ireas/guides/contributing.md

## Contact

For bug reports, feature requests and other messages, please send a mail to
[~ireas/nitrokey-rs-dev@lists.sr.ht][] ([archive][]) using the `[nitrokey3-rs]`
prefix in the subject.

## License

This project is dual-licensed under the [Apache-2.0][] and [MIT][] licenses.
The documentation and examples contained in this repository are licensed under
the [Creative Commons Zero][CC0] license.  You can find a copy of the license
texts in the `LICENSES` directory.

`nitrokey3-rs` complies with [version 3.0 of the REUSE specification][reuse].

[Apache-2.0]: https://opensource.org/licenses/Apache-2.0
[MIT]: https://opensource.org/licenses/MIT
[CC0]: https://creativecommons.org/publicdomain/zero/1.0/
[reuse]: https://reuse.software/practices/3.0/