diff --git a/README.md b/README.md index 3a215bb..eadc5b9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ +⚠️ **Warning:** _This code is grossly incomplete and under-tested! Don't use it yet, except to hack on it._ + # go-onerng -A Go port of the OneRNG tools + +This is a Go port of the OneRNG tools distributed at https://onerng.info/. Much credit is due to the OneRNG creators - all I'm doing here is porting a bunch of Bash and Python code to Go. + +## Roadmap + +This isn't anywhere near ready for prime-time yet. Here's what I want to be able to do with it: + +- [x] print the version (`cmdv`) +- [x] print the ID (`cmdI`) +- [ ] verify the image (`cmdX` & verify PGP signature) +- [ ] generate some amount of entropy +- [ ] add extra AES128-whitening +- [ ] run as a daemon and integrate with `rngd`