Skip to content
This repository was archived by the owner on Oct 8, 2024. It is now read-only.

Commit 320bdd0

Browse files
committed
Updated README
1 parent 2cf18a7 commit 320bdd0

File tree

2 files changed

+43
-16
lines changed

2 files changed

+43
-16
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ body:
3535
options:
3636
- v0.5.x
3737
- v0.4.x
38-
- v0.3.x
39-
- v0.2.0 or lower
38+
- v0.3.0 or lower
4039
validations:
4140
required: true
4241
- type: dropdown

README.md

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,40 @@
1-
# Stalwart JMAP Server
2-
3-
[![Build](https://github.com/stalwartlabs/jmap-server/actions/workflows/build.yml/badge.svg)](https://github.com/stalwartlabs/jmap-server/actions/workflows/build.yml)
4-
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
5-
[![](https://img.shields.io/discord/923615863037390889?label=Chat)](https://discord.gg/jtgtCNj66U)
6-
[![](https://img.shields.io/twitter/follow/stalwartlabs)](https://twitter.com/stalwartlabs)
7-
[![](https://img.shields.io/mastodon/follow/109929667531941122)](https://mastodon.social/@stalwartlabs)
1+
<h2 align="center">
2+
<a href="https://stalw.art">
3+
<img src="https://stalw.art/home/apple-touch-icon.png" height="60">
4+
</a>
5+
<br>
6+
Stalwart JMAP Server
7+
</h1>
8+
9+
<p align="center">
10+
<i align="center">Secure & Modern JMAP Server</i> 🛡️
11+
</p>
12+
13+
<h4 align="center">
14+
<a href="https://github.com/stalwartlabs/mail-server/actions/workflows/build.yml">
15+
<img src="https://img.shields.io/github/actions/workflow/status/stalwartlabs/mail-server/build.yml?style=flat-square" alt="continuous integration">
16+
</a>
17+
<a href="https://www.gnu.org/licenses/agpl-3.0">
18+
<img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?label=license&style=flat-square" alt="License: AGPL v3">
19+
</a>
20+
<a href="https://stalw.art/docs/get-started/">
21+
<img src="https://img.shields.io/badge/read_the-docs-red?style=flat-square" alt="Documentation">
22+
</a>
23+
<br>
24+
<a href="https://mastodon.social/@stalwartlabs">
25+
<img src="https://img.shields.io/mastodon/follow/109929667531941122?style=flat-square&logo=mastodon&color=%236364ff" alt="Mastodon">
26+
</a>
27+
<a href="https://twitter.com/stalwartlabs">
28+
<img src="https://img.shields.io/twitter/follow/stalwartlabs?style=flat-square&logo=twitter" alt="Twitter">
29+
</a>
30+
<br>
31+
<a href="https://discord.gg/jtgtCNj66U">
32+
<img src="https://img.shields.io/discord/923615863037390889?label=discord&style=flat-square" alt="Discord">
33+
</a>
34+
<a href="https://matrix.to/#/#stalwart:matrix.org">
35+
<img src="https://img.shields.io/matrix/stalwartmail%3Amatrix.org?label=matrix&style=flat-square" alt="Matrix">
36+
</a>
37+
</h4>
838

939
**Stalwart JMAP** is an open-source JSON Meta Application Protocol server designed to be secure, fast, robust and scalable.
1040
JMAP is a modern protocol for synchronising data such as mail, calendars, or contacts that makes much more efficient use of network resources.
@@ -16,24 +46,22 @@ Key features:
1646
- JMAP Mail ([RFC 8621](https://datatracker.ietf.org/doc/html/rfc8621))
1747
- JMAP over WebSocket ([RFC 8887](https://datatracker.ietf.org/doc/html/rfc8887))
1848
- JMAP for Sieve Scripts ([DRAFT-SIEVE-13](https://www.ietf.org/archive/id/draft-ietf-jmap-sieve-13.html)).
19-
- **Flexible**:
20-
- **LDAP** directory and **SQL** database authentication.
49+
- **Flexible and scalable**:
50+
- Pluggable storage backends with **RocksDB**, **FoundationDB**, **PostgreSQL**, **mySQL**, **SQLite**, **S3-Compatible**, **Redis** and **ElasticSearch** support.
51+
- **Internal**, **LDAP** and **SQL** database authentication.
2152
- Built-in [SMTP](https://github.com/stalwartlabs/smtp-server) server for local delivery and JMAP Email Submissions.
2253
- Full-text search available in 17 languages.
2354
- Disk quotas.
2455
- Sieve scripting language with support for all [registered extensions](https://www.iana.org/assignments/sieve-extensions/sieve-extensions.xhtml).
2556
- Email aliases, mailing lists, subaddressing and catch-all addresses support.
2657
- Integration with **OpenTelemetry** to enable monitoring, tracing, and performance analysis.
27-
- **Secure**:
58+
- **Secure and robust**:
2859
- Encryption at rest with **S/MIME** or **OpenPGP**.
2960
- Built-in Spam and Phishing filter.
3061
- OAuth 2.0 [authorization code](https://www.rfc-editor.org/rfc/rfc8628) and [device authorization](https://www.rfc-editor.org/rfc/rfc8628) flows.
3162
- Access Control Lists (ACLs).
3263
- Rate limiting.
33-
- **Robust and scalable**:
34-
- **FoundationDB** or **SQLite** database backends.
35-
- **S3-compatible** blob storage support.
36-
- Memory safe (thanks to Rust).
64+
- Memory safe (thanks to Rust).
3765

3866
## Get Started
3967

0 commit comments

Comments
 (0)