From 599adb6b2d6b9a624e96b82a14ddf5f11995eb9b Mon Sep 17 00:00:00 2001 From: Christopher Waldon Date: Tue, 14 Apr 2020 09:29:03 -0400 Subject: [PATCH] doc: update README to use valid go.mod example syntax (#39) This commit simply uses parenthesis in the example `go.mod` `require` block since curly braces are illegal there. If a potential user copies the text as the basis for starting a new `go.mod`, they'll get cryptic compilation errors. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c932986..0075e7f 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,10 @@ crypto library](https://github.com/ProtonMail/crypto). To use this library using [Go Modules](https://github.com/golang/go/wiki/Modules) just edit your `go.mod` configuration to contain: ```gomod -require { +require ( ... github.com/ProtonMail/gopenpgp/v2 v2.0.0 -} +) replace golang.org/x/crypto => github.com/ProtonMail/crypto v0.0.0-20191122234321-e77a1f03baa0 ``` @@ -384,4 +384,4 @@ if !isVerified { } ``` This function runs on unlocked private keys, and it will return an error if called with public keys -or locked keys. \ No newline at end of file +or locked keys.