Update README
This commit is contained in:
22
README.md
22
README.md
@@ -1,6 +1,8 @@
|
||||
<div align="center">
|
||||
<img src="images/korax.png" alt="Korax" width="160"/>
|
||||
|
||||
<!-- TODO: Add App Screenshot showing native PGP workflows -->
|
||||
|
||||
# Korax
|
||||
|
||||
**PGP-First Email. Private by Default.**
|
||||
@@ -17,6 +19,10 @@ Korax is an email client built around a single principle: **encryption should be
|
||||
|
||||
Most clients bolt PGP on as an afterthought — a plugin, a hidden setting, a third-party extension. Korax is designed from the ground up so that signing, encryption, and key management are a seamless part of your everyday workflow. Your mail stays between you and the people you write to.
|
||||
|
||||
### Why Korax?
|
||||
|
||||
Default mail apps (like Apple Mail) cannot read or compose PGP encrypted emails natively. Korax was born out of simple frustration: the inability to easily read encrypted emails (such as Kraken security alerts) out of the box. Instead of fighting with extensions, Korax provides a first-class, zero-friction PGP experience.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
@@ -118,6 +124,14 @@ The UI layer never blocks: all network and crypto operations run in Rust, commun
|
||||
|
||||
The source is published here for transparency and community audit. It is licensed under the [PolyForm Noncommercial License 1.0.0](LICENSE) — free to read, study, and use for noncommercial purposes. Commercial use requires a separate agreement.
|
||||
|
||||
#### Building & Testing `mailcore`
|
||||
To build and test the `mailcore` engine locally:
|
||||
```bash
|
||||
cd mailcore
|
||||
cargo build
|
||||
cargo test
|
||||
```
|
||||
|
||||
**What stays proprietary:**
|
||||
|
||||
The PGP/Sequoia integration, advanced privacy features, the proprietary Rust engine, and the Flutter UI (`korax/`) are not published.
|
||||
@@ -126,9 +140,15 @@ The PGP/Sequoia integration, advanced privacy features, the proprietary Rust eng
|
||||
|
||||
## Security
|
||||
|
||||
**Key storage:** Private keys are never written to SQLite or disk in plaintext. On every platform, they are stored in the OS secure enclave (iOS Keychain, macOS Keychain, Android Keystore).
|
||||
|
||||
## Support & Contributing
|
||||
|
||||
**Bug Reports:** Korax includes a built-in bug reporting feature directly within the application. Please use that for all general issues and feedback.
|
||||
|
||||
**Reporting vulnerabilities:** Do not open a public issue. Contact the maintainer directly at the address shown in the application's About screen.
|
||||
|
||||
**Key storage:** Private keys are never written to SQLite or disk in plaintext. On every platform, they are stored in the OS secure enclave (iOS Keychain, macOS Keychain, Android Keystore).
|
||||
**Contributing:** Core development is handled internally. At this time, we do not accept external pull requests or community code contributions.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user