diff --git a/README.md b/README.md index c850c5e..3ec14dd 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ you're using won't have breaking changes** - [Documentation](https://godoc.org/github.com/lrstanley/girc) is _mostly_ complete. - Support for almost all of the IRCv3 spec. - SASL Auth (currently only `PLAIN` and `EXTERNAL` is support by default, - however you can simply implement `SASLMethod` yourself to support additional + however you can simply implement `SASLMech` yourself to support additional mechanisms.) - Message tags (and with this, things like `account-tag` on by default) - `account-notify`, `away-notify`, `chghost`, `extended-join`, etc -- all handled seemlessly ([cap.go](https://github.com/lrstanley/girc/blob/master/cap.go) for more info). diff --git a/cap.go b/cap.go index 575ceb8..66f68fa 100644 --- a/cap.go +++ b/cap.go @@ -172,9 +172,9 @@ func handleCAP(c *Client, e Event) { } } -// SASLMethod is an representation of what a SASL mechanism should support. +// SASLMech is an representation of what a SASL mechanism should support. // See SASLExternal and SASLPlain for implementations of this. -type SASLMethod interface { +type SASLMech interface { // Method returns the uppercase version of the SASL mechanism name. Method() string // Encode returns the response that the SASL mechanism wants to use, diff --git a/client.go b/client.go index 22a009c..93046b3 100644 --- a/client.go +++ b/client.go @@ -80,10 +80,10 @@ type Config struct { // affect during the dial process. Name string // SASL contains the necessary authentication data to authenticate - // with SASL. See the documentation for SASLMethod for what is currently + // with SASL. See the documentation for SASLMech for what is currently // supported. Capability tracking must be enabled for this to work, as // this requires IRCv3 CAP handling. - SASL SASLMethod + SASL SASLMech // Proxy is a proxy based address, used during the dial process when // connecting to the server. This only has an affect during the dial // process. Currently, x/net/proxy only supports socks5, however you can