WIP

README.md

@@ -0,0 +1,61 @@
+i2p-yubikey-tools
+==============================
+
+Documentation and tools for storing your i2p keys on a yubikey,
+and doing signing and authentication.
+
+Use cases:
+
+- Storing eepsite private keys
+- Storing su3 plugin keys
+- Signing su3 files
+- Offline LS2 keys
+- Authentication using your eepsite private keys
+- GPG?
+
+
+SUPPORTED PLATFORMS
+-------------------
+
+Linux Debian/Ubuntu type systems only.
+I2P must be installed either as a debian package,
+or as a manual install in $HOME/i2p.
+
+For best results, I2P dev build TBD or higher required.
+
+
+RECOMMENDED YUBIKEY
+------------------------
+
+Yubikey 5 NFC $45
+https://www.yubico.com/product/yubikey-5-nfc
+
+Overview of other Yubikey products:
+https://www.yubico.com/products/compare-products-series/
+
+Yubikey 4:
+Probably not.
+
+Non-Yubico products:
+Probably not. Required features: TBD.
+
+
+
+INSTALLATION
+------------
+
+
+
+USAGE
+-----
+
+
+
+BUGS
+----
+
+Please report bugs and patches on zzz.i2p or http://git.idk.i2p/zzz/i2p-yubikey-tools
+
+If things go well maybe we'll add this to our installers and packages.
+
+zzz