git » spf » commit 842a94c

doc: Update links and references

author Alberto Bertogli
2020-07-24 18:40:18 UTC
committer Alberto Bertogli
2020-07-24 18:40:18 UTC
parent f2bd062b6f62171b7d99d37d2a8fc6417b1f90a3
doc: Update links and references

This patch updates the README and package documentation links and
references, to point to pkg.go.dev, add some missing supported
mechanisms, and reference maddy as another user of the library.
README.md +7 -6
spf.go +5 -4 
diff --git a/README.md b/README.md
index 7cf6f3a..5994ede 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 
 # blitiri.com.ar/go/spf
 
-[![GoDoc](https://godoc.org/blitiri.com.ar/go/spf?status.svg)](https://godoc.org/blitiri.com.ar/go/spf)
+[![GoDoc](https://godoc.org/blitiri.com.ar/go/spf?status.svg)](https://pkg.go.dev/blitiri.com.ar/go/spf)
 [![Build Status](https://travis-ci.org/albertito/spf.svg?branch=master)](https://travis-ci.org/albertito/spf)
 [![Go Report Card](https://goreportcard.com/badge/github.com/albertito/spf)](https://goreportcard.com/report/github.com/albertito/spf)
 [![Coverage Status](https://coveralls.io/repos/github/albertito/spf/badge.svg?branch=next)](https://coveralls.io/github/albertito/spf)
@@ -9,7 +9,8 @@
 [spf](https://godoc.org/blitiri.com.ar/go/spf) is an open source
 implementation of the Sender Policy Framework (SPF) in Go.
 
-It is used by the [chasquid](https://blitiri.com.ar/p/chasquid/) SMTP server.
+It is used by the [chasquid](https://blitiri.com.ar/p/chasquid/) and
+[maddy](https://foxcpp.dev/maddy) SMTP servers.
 
 
 ## Example
@@ -27,8 +28,8 @@ if result == spf.Fail {
 }
 ```
 
-See the [documentation](https://godoc.org/blitiri.com.ar/go/spf) for more
-details.
+See the [package documentation](https://pkg.go.dev/blitiri.com.ar/go/spf) for
+more details.
 
 
 ## Status
@@ -40,9 +41,9 @@ to the mailing list (details below).
 ## Contact
 
 If you have any questions, comments or patches please send them to the mailing
-list, chasquid@googlegroups.com.
+list, `chasquid@googlegroups.com`.
 
-To subscribe, send an email to chasquid+subscribe@googlegroups.com.
+To subscribe, send an email to `chasquid+subscribe@googlegroups.com`.
 
 You can also browse the
 [archives](https://groups.google.com/forum/#!forum/chasquid).
diff --git a/spf.go b/spf.go
index b26a60c..a173835 100644
--- a/spf.go
+++ b/spf.go
@@ -5,18 +5,19 @@
 // exchangers to check that incoming mail from a domain comes from a host
 // authorized by that domain's administrators [Wikipedia].
 //
-// This is a Go implementation of it, which is used by the chasquid SMTP
-// server (https://blitiri.com.ar/p/chasquid/).
+// This package is intended to be used by SMTP servers to implement SPF
+// validation.
 //
-// Supported mechanisms and modifiers:
+// All mechanisms and modifiers are supported:
 //   all
 //   include
 //   a
 //   mx
+//   ptr
 //   ip4
 //   ip6
-//   redirect
 //   exists
+//   redirect
 //   exp (ignored)
 //   Macros
 //