Add README

This commit is contained in:
Sosthène Guédon
2022-11-08 15:06:12 +01:00
parent 622fb5a41d
commit 043094f8be
+35
View File
@@ -0,0 +1,35 @@
<!--
Copyright (C) 2022 Nitrokey GmbH
SPDX-License-Identifier: CC0-1.0
-->
PIV-Authenticator
=================
`piv-authenticator` is a Rust implematation of the [Personnal Identity Verification](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-73-4.pdf) smartcard.
Supported features
------------------
`piv-authenticator` is still under heavy development and currently doesn't support most of PIV's features.
See the [tracking issue for command support](https://github.com/Nitrokey/piv-authenticator/issues/1) for more information.
License
-------
This project is licensed under the [GNU Lesser General Public License (LGPL)
version 3][LGPL-3.0]. Configuration files and examples are licensed under the
[CC0 1.0 license][CC0-1.0]. The [original work][original] by [Solokeys][solokeys] from which this repository is forked from is licensed under [Apache-2.0][Apache-2.0] OR [MIT][MIT] For more information, see the license header in
each file. You can find a copy of the license texts in the
[`LICENSES`](./LICENSES) directory.
[LGPL-3.0]: https://opensource.org/licenses/LGPL-3.0
[CC0-1.0]: https://creativecommons.org/publicdomain/zero/1.0/
[Apache-2.0]: https://www.apache.org/licenses/LICENSE-2.0.html
[MIT]: https://en.wikipedia.org/wiki/MIT_License
[solokeys]: https://solokeys.com/
[original]: https://github.com/solokeys/piv-authenticator
This project complies with [version 3.0 of the REUSE specification][reuse].
[reuse]: https://reuse.software/practices/3.0/