author | Alberto Bertogli
<albertito@blitiri.com.ar> 2019-10-25 14:39:00 UTC |
committer | Alberto Bertogli
<albertito@blitiri.com.ar> 2019-10-25 15:00:15 UTC |
parent | e8511e3f5589ba6979fe4e6f4cfece5685c01ea2 |
README.md | +17 | -15 |
diff --git a/README.md b/README.md index 5bd63c7..f18dead 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,12 @@ It is designed mainly for individuals and small groups. It's written in [Go](https://golang.org), and distributed under the [Apache license 2.0](http://en.wikipedia.org/wiki/Apache_License). -[![Travis-CI build status](https://travis-ci.org/albertito/chasquid.svg?branch=master)](https://travis-ci.org/albertito/chasquid) -[![pipeline status](https://gitlab.com/albertito/chasquid/badges/master/pipeline.svg)](https://gitlab.com/albertito/chasquid/commits/master) +[![Travis-CI status](https://travis-ci.org/albertito/chasquid.svg?branch=master)](https://travis-ci.org/albertito/chasquid) +[![Gitlab CI status](https://gitlab.com/albertito/chasquid/badges/master/pipeline.svg)](https://gitlab.com/albertito/chasquid/pipelines) [![Go Report Card](https://goreportcard.com/badge/github.com/albertito/chasquid)](https://goreportcard.com/report/github.com/albertito/chasquid) -[![Coverage Status](https://coveralls.io/repos/github/albertito/chasquid/badge.svg?branch=next)](https://coveralls.io/github/albertito/chasquid?branch=next) -[![GoDoc](https://godoc.org/blitiri.com.ar/go/chasquid?status.svg)](https://godoc.org/blitiri.com.ar/go/chasquid) -[![Freenode](https://img.shields.io/badge/chat-freenode-brightgreen.svg)](https://webchat.freenode.net?channels=%23chasquid) +[![Coverage](https://img.shields.io/badge/coverage-next-brightgreen.svg)](https://blitiri.com.ar/p/chasquid/coverage.html) +[![Docs](https://img.shields.io/badge/docs-reference-blue.svg)](https://blitiri.com.ar/p/chasquid/docs/) +[![Freenode](https://img.shields.io/badge/chat-freenode-blue.svg)](https://webchat.freenode.net/#chasquid) ## Features @@ -23,14 +23,14 @@ It's written in [Go](https://golang.org), and distributed under the * Easy to configure. * Hard to mis-configure in ways that are harmful or insecure (e.g. no open relay, or clear-text authentication). - * Monitoring HTTP server, with exported variables and tracing to help + * [Monitoring] HTTP server, with exported variables and tracing to help debugging. * Integrated with [Debian] and [Ubuntu]. * Supports using [Dovecot] for authentication. * Useful * Multiple/virtual domains, with per-domain users and aliases. * Suffix dropping (`user+something@domain` → `user@domain`). - * Hooks for integration with greylisting, anti-virus, anti-spam, and + * [Hooks] for integration with greylisting, anti-virus, anti-spam, and DKIM/DMARC. * International usernames ([SMTPUTF8]) and domain names ([IDNA]). * Secure @@ -40,22 +40,24 @@ It's written in [Go](https://golang.org), and distributed under the * [SPF] and [MTA-STS] checking. -[SMTPUTF8]: https://en.wikipedia.org/wiki/Extended_SMTP#SMTPUTF8 +[Debian]: https://debian.org +[Dovecot]: https://blitiri.com.ar/p/chasquid/docs/dovecot/ +[Hooks]: https://blitiri.com.ar/p/chasquid/docs/hooks/ [IDNA]: https://en.wikipedia.org/wiki/Internationalized_domain_name [Let's Encrypt]: https://letsencrypt.org -[Dovecot]: https://dovecot.org -[SPF]: https://en.wikipedia.org/wiki/Sender_Policy_Framework [MTA-STS]: https://tools.ietf.org/html/rfc8461 -[Debian]: https://debian.org -[Ubuntu]: https://ubuntu.com +[Monitoring]: https://blitiri.com.ar/p/chasquid/docs/monitoring/ +[SMTPUTF8]: https://en.wikipedia.org/wiki/Extended_SMTP#SMTPUTF8 +[SPF]: https://en.wikipedia.org/wiki/Sender_Policy_Framework [Tracking]: https://blitiri.com.ar/p/chasquid/docs/sec-levels/ +[Ubuntu]: https://ubuntu.com ## Documentation -The [how-to guide](docs/howto.md) and the [installation -guide](docs/install.md) are the best starting points on how to install, -configure and run chasquid. +The [how-to guide](https://blitiri.com.ar/p/chasquid/docs/howto/) and the +[installation guide](https://blitiri.com.ar/p/chasquid/docs/install/) are the +best starting points on how to install, configure and run chasquid. You will find [all documentation here](https://blitiri.com.ar/p/chasquid/docs/).