diff --git a/README.md b/README.md index 478f26a..646e92d 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,22 @@ vage is an implementation of the [age encryption specification](https://age-encr not yet installable. -currently, only the vage-keygen command is implemented, and for x25519 identities. +currently, both the vage-keygen and vage commands are implemented for x25519 identities, supporting both encryption and decryption. this project is not officially endorsed by the creators of age. + +## about + +this project aims to be much lighter than [the official go implementation](https://age-encryption.org) of age while matching or exceeding it in terms of performance. + +## getting started + +1. make sure you have [v](https://vlang.io/) installed +2. run `make` or just manually compile the binaries with `v cmd/vage.v` and `v cmd/vage-keygen.v`. + + +## to-do list + +- [ ] armored encrypt/decrypt +- [ ] postquantum support +- [ ] scrypt support