diff --git a/README.md b/README.md index fa95019..c3c6cc4 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,31 @@ Husk is written in Rust and uses Sequoia PGP for encryption and certificate hand ## Status -Milestone 3 is reached and with it Husk has aquired a set of new features: +Milestone 4 is reached and Husk gains some new features: -- Online sources (keyservers, WKD, DANE) are now queried for missing - certificates. -- Introducers are now available: certificates are only used if they are - certified by an introducer and match its list of configured domains. -- Locals are available: These are certificates hand picked and added - by the administrator. +- Husk will wrap an email it encrypts into a fitting mime structure + so that MTUs (Mail user agent, like Thunderbird) can display the + message properly. +- Husk now can deal which attachments. +- Header protection will be used with encrypted emails. +- Husk can sign messages if you provide it with an appropriate key. +- Hush can now send itself into the background. It now understands start, stop + and status. +- When building Husk from source, files for shell completion are generated. +- When listing introducers their associated domains are also displayed. + +Please refer to the [documentation](/documentation) for a full list of all +features and their usage. + +Husk can now be used safely for pass-through mail encryption, **but**: + +As Husk only encrypts if an authenticated certificate is available, emails +with more than one recipient are only encrypted if there are certificates +for all recipients - otherwise the mail will not be changed. That means +that even if a certificate is available for a certain recipient, it might +not be used. + +This behavior will be improved in milestone 5. ## Documentation