Documentation fixes (#43)
* Fix Comment - NewKeyFromReader * Trailing whitespace, correct function name * Update CHANGELOG * update README Co-authored-by: zugzwang <talbotvinnik@pm.me> Co-authored-by: Aron Wussler <aron@wussler.it>
This commit is contained in:
parent
486e1220a1
commit
0f35072bc4
3 changed files with 14 additions and 9 deletions
|
|
@ -5,8 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
### Security
|
||||
- Updated underlying crypto library
|
||||
|
||||
### Fixed
|
||||
- Fixed test `TestMultipleKeyMessageEncryption`
|
||||
- Fixed garbage collection issues when compiled on gomobile, by copying byte slices
|
||||
|
||||
### Added
|
||||
- SHA256 fingerprint support
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
# GopenPGP V2
|
||||
[](https://travis-ci.org/ProtonMail/gopenpgp)
|
||||
|
||||
GopenPGP is a high-level OpenPGP library built on top of [a fork of the golang
|
||||
crypto library](https://github.com/ProtonMail/crypto).
|
||||
|
|
@ -360,8 +361,8 @@ pgpMessage := pgpSplitMessage.GetPGPMessage()
|
|||
|
||||
// And vice-versa
|
||||
newPGPSplitMessage, err := pgpMessage.SeparateKeyAndData()
|
||||
// Key Packet is in newPGPSplitMessage.GetKeyPacket()
|
||||
// Data Packet is in newPGPSplitMessage.GetDataPacket()
|
||||
// Key Packet is in newPGPSplitMessage.GetBinaryKeyPacket()
|
||||
// Data Packet is in newPGPSplitMessage.GetBinaryDataPacket()
|
||||
```
|
||||
|
||||
### Checking keys
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ func NewKeyFromArmoredReader(r io.Reader) (key *Key, err error) {
|
|||
return key, nil
|
||||
}
|
||||
|
||||
// NewKeyFromReader reads an binary data into Key
|
||||
// NewKeyFromReader reads binary data into a Key object.
|
||||
func NewKeyFromReader(r io.Reader) (key *Key, err error) {
|
||||
key = &Key{}
|
||||
err = key.readFrom(r, false)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue