Skip to content

Commit

Permalink
Update README to note payload behavior changes
Browse files Browse the repository at this point in the history
Note that transparent compression/decompression is now performed
when managing payloads.

Drop explicit mention of Ascii85 as encoding format. While we
continue to use it, the specifics are less important.

refs GH-301
  • Loading branch information
atc0005 committed Nov 16, 2024
1 parent a23db12 commit cfaa311
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,13 @@ such time that the API is considered stable.
- Automatically omit `LongServiceOutput` section if not specified by client
code
- Support for overriding text used for section headers/labels
- Support for adding/embedding an encoded payload (Ascii85) in plugin output
- Support for decoding (Ascii85) encoded input (payload)
- Support for extracting an (Ascii85) encoded payload from captured plugin
- Support for adding/embedding a compressed and encoded payload in plugin
output
- Support for extracting and decoding an (Ascii85) encoded payload (into the
original non-encoded form) from captured plugin output
- Support for decoding and decompressing encoded input (payload)
- Support for extracting (without decoding & decompressing) an encoded payload
from captured plugin output
- Support for extracting, decoding and decompressing an encoded payload (into
the original non-encoded form) from captured plugin output
- Optional debug logging for plugin activity
- debug log output is sent to `stderr` by default but can be redirected to a
custom target
Expand Down

0 comments on commit cfaa311

Please sign in to comment.