wildduck/README.md
Rezart Qelibari bbe0e69323
Add OpenAPI verification badge to README (#421)
Having the OpenAPI verification badge on the README is not only a sign of quality of a great feature but also a good indicator to quickly catch errors in the OpenAPI file.
2023-09-05 19:44:30 +03:00

32 lines
2.1 KiB
Markdown

# WildDuck Mail Server
<p align="center">
<a href="https://wildduck.email" target="blank"><img src="./graphics/wildduck-type.svg" width="256" alt="Wild Duck" /></a>
<br />
WildDuck is a scalable no-SPOF IMAP/POP3 mail server.
</p>
<p align="center">
<a href="https://travis-ci.org/github/nodemailer/wildduck" target="_blank"><img src="https://img.shields.io/travis/nodemailer/wildduck" alt="build" /></a>
<a href="https://david-dm.org/nodemailer/wildduck" target="_blank"><img src="https://img.shields.io/david/nodemailer/wildduck" alt="dependencies" /></a>
<a href="https://david-dm.org/nodemailer/wildduck?type=dev" target="_blank"><img src="https://img.shields.io/david/dev/nodemailer/wildduck?label=devDependencies" alt="devDependencies" /></a>
<a href="https://snyk.io/test/github/nodemailer/wildduck" target="_blank"><img src="https://img.shields.io/snyk/vulnerabilities/github/nodemailer/wildduck" alt="Vulnerabilities" /></a>
<a href="https://hub.docker.com/r/nodemailer/wildduck" target="_blank"><img src="https://img.shields.io/docker/image-size/nodemailer/wildduck?label=docker%20image" alt="docker" /></a>
<a href="https://gitter.im/nodemailer/wildduck" target="_blank"><img src="https://img.shields.io/gitter/room/nodemailer/wildduck?color=orange" alt="gitter" /></a>
<a href="https://docs.wildduck.email/api/openapi.yml"><img src="https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Fdocs.wildduck.email%2Fapi%2Fopenapi.yml"></a>
</p>
WildDuck uses a distributed database (sharded + replicated MongoDB) as a backend for storing all data, including emails.
WildDuck tries to follow Gmail in product design. If there's a decision to be made then usually the answer is to do whatever Gmail has done.
## Links
- [Website](https://wildduck.email)
- [Documentation](https://docs.wildduck.email)
- [Installation instructions](https://docs.wildduck.email/#/general/install)
- [API Documentation](https://docs.wildduck.email/api)
## License
WildDuck Mail Agent is licensed under the [European Union Public License 1.2](https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12) or later.