From cdb40ed599a21f656d69778c21446da85f59873f Mon Sep 17 00:00:00 2001 From: alexander <116556921+al-kau@users.noreply.github.com> Date: Mon, 17 Jun 2024 17:08:05 +0300 Subject: [PATCH] Update: Readme.md (#262) * Update: Readme.md - badges were added * Update: Readme.md - release badge was added --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c4d57ff..66a41c1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,16 @@ # Eppie — open protocol encrypted p2p email +[![LicenseBadge](https://img.shields.io/github/license/Eppie-io/Eppie-App.svg)](https://github.com/raw/Eppie-io/Eppie-App/main/LICENSE) +[![Build and Test](https://img.shields.io/github/actions/workflow/status/Eppie-io/Eppie-App/build.yml?logo=github&branch=main&event=push)](https://github.com/Eppie-io/Eppie-App/actions/workflows/build.yml?query=branch%3Amain+event%3Apush) [![Crowdin](https://badges.crowdin.net/e/8fee200a40ee70ffd3fa6b7d8d23deee/localized.svg)](https://eppie.crowdin.com/eppie) +[![Release](https://img.shields.io/github/v/release/Eppie-io/Eppie-App)](https://github.com/Eppie-io/Eppie-App/releases/latest) ## Intro + [Eppie](https://eppie.io) is a next-gen _providerless_ email that allows its users to own their accounts, addresses and data. In addition to its own p2p network Eppie can communicate with other popular decentralized networks, like Ethereum, and is capable of interacting with conventional IMAP/SMTP email. It is beautiful and easy to use, just like a normal email client. ## Motivation + Out of 4+ billion email accounts in the world, about 0 belong to users. A typical mailbox contains all sorts of important private information of our business and social activity, finance, health, consumer behaviour etc. Furthermore email is the primary identity provider in the modern Internet. We use our email address to log in to hundreds of other services. Email is the core of our digital identity. Yet we do not own it. It is controlled by a server and therefore belongs to the technology provider. The server decides whether to allow us to use our identity or not. This is a privacy violation by design. Identity naturally belongs to human, it should not be a service. @@ -13,7 +18,9 @@ A typical mailbox contains all sorts of important private information of our bus At its core, the users’ confidence that their data is accessible to them, and not to anyone else, relies on trust in the service. Privacy based on trust is weak. In Eppie mailbox belongs exclusively to the owner of the private key. Eppie operates autonomously in a p2p networks There are no servers or other authorities ‘providing the service’ and therefore controlling the data. Nobody has access to data, even us, the developers. The system relies solely on strong cryptography and the decetralized architecture. ## Features + Eppie is early in development. The p2p part is not publicly available at the moment. For now it works as a conventional email client with additional security features: + - Compatibility with Gmail, Microsoft Outlook and other major email providers. - Eppie can authentication at Proton Mail servers (which no other native desktop clients can do, as far as we are aware). - PGP encryption is supported. @@ -21,6 +28,7 @@ Eppie is early in development. The p2p part is not publicly available at the mom - Encrypted local backup. ## Install from Microsoft Store, App Store or Google Play + There's a preview version currently available at Microsoft Store.

@@ -31,25 +39,30 @@ There's a preview version currently available at Microsoft Store. WIP ## Download latest binaries + WIP ## Build from source + WIP ## Planned features + As the project matures more features will be added, including but not limited to -* Creating a decentralized Eppie account -* Encrypted p2p messaging -* Encrypted decentralized backup -* Connecting existing decentralized identities, e.g. [ENS](https://ens.domains/) + +- Creating a decentralized Eppie account +- Encrypted p2p messaging +- Encrypted decentralized backup +- Connecting existing decentralized identities, e.g. [ENS](https://ens.domains/) ## Technology Stack + At launch Eppie will to store the data using [IPFS](https://github.com/ipfs/ipfs) infrastructure, and the transport layer will work through [SBBS](https://github.com/BeamMW/beam/wiki/Secure-bulletin-board-system-%28SBBS%29). With that being said, the architecture allows to easily plug in multiple storage and transport technologies. Eppie's e2e encryption is based on [Elliptic-curve](https://en.wikipedia.org/wiki/Elliptic-curve_cryptography) cryptography. GUI application is being written in C# with [Uno](https://github.com/unoplatform/uno), and [CLI](https://github.com/Eppie-io/Eppie-CLI) is pure C#. Eppie targets Windows, macOS, Linux, iOS, and Android platforms. ## Contribution + First of all this is a pretty ambitiois project and we are greateful beyond measure for every bit of help from our community. If you decide to contribute, please create an issue first, or find an existing one, unless it's a very minor fix, like a typo. [Here](https://eppie.crowdin.com/eppie) you can help Eppie with localization. Also, feel free to [subscripe](https://eppie.io) to our waiting list. We might invite you for an interview or beta testing. -