lysann/passforios-gopenpgp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: update README to use valid go.mod example syntax (#39)

Browse source 
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.
This commit is contained in:
Christopher Waldon 2020-04-14 09:29:03 -04:00 • committed by GitHub
parent 10a9a0f557
commit 599adb6b2d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -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 To use this library using [Go Modules](https://github.com/golang/go/wiki/Modules) just edit your
`go.mod` configuration to contain: `go.mod` configuration to contain:
```gomod ```gomod
require { require (
... ...
github.com/ProtonMail/gopenpgp/v2 v2.0.0 github.com/ProtonMail/gopenpgp/v2 v2.0.0
} )
replace golang.org/x/crypto => github.com/ProtonMail/crypto v0.0.0-20191122234321-e77a1f03baa0 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 This function runs on unlocked private keys, and it will return an error if called with public keys
or locked keys. or locked keys.