You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-2
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ CBOR is a [trusted alternative](https://www.rfc-editor.org/rfc/rfc8949.html#name
8
8
9
9
`fxamacker/cbor` is used in projects by Arm Ltd., Cisco, Dapper Labs, EdgeX Foundry, Fraunhofer‑AISEC, Let's Encrypt (ISRG), Linux Foundation, Microsoft, Mozilla, Oasis Protocol, Tailscale, Teleport, [and others](https://github.com/fxamacker/cbor#who-uses-fxamackercbor).
10
10
11
-
See [Quick Start](#quick-start) and [v2.5.0](https://github.com/fxamacker/cbor/releases/tag/v2.5.0). New funcs `UnmarshalFirst` and `DiagnoseFirst`return remaining bytes.
11
+
See [Quick Start](#quick-start) and [Releases](https://github.com/fxamacker/cbor/releases/). 🆕 `UnmarshalFirst` and `DiagnoseFirst`can decode CBOR Sequences.
12
12
13
13
## fxamacker/cbor
14
14
@@ -219,6 +219,13 @@ __Install__: `go get github.com/fxamacker/cbor/v2` and `import "github.com/fxama
219
219
220
220
### Key Points
221
221
222
+
This library can encode and decode CBOR (RFC 8949) and CBOR Sequences (RFC 8742).
223
+
224
+
-__CBOR data item__ is a single piece of CBOR data and its structure may contain zero, one, or more nested data items.
225
+
-__CBOR sequence__ is a concatenation of 0 or more encoded CBOR data items.
226
+
227
+
Configurable limits and options can be used to balance trade-offs.
228
+
222
229
- Encoding and decoding modes are created from options (settings).
223
230
- Modes can be created at startup and reused.
224
231
- Modes are safe for concurrent use.
@@ -452,6 +459,12 @@ Default limits may need to be increased for systems handling very large data (e.
452
459
453
460
## Status
454
461
462
+
v2.6.0 (February 2024) adds important new features, optimizations, and bug fixes. It is especially useful to systems that need to convert data between CBOR and JSON. New options and optimizations improve handling of bignum, integers, maps, and strings.
463
+
464
+
For more details, see [release notes](https://github.com/fxamacker/cbor/releases).
465
+
466
+
### Prior Release
467
+
455
468
v2.5.0 was released on Sunday, August 13, 2023 with new features and important bug fixes. It is fuzz tested and production quality after extended beta [v2.5.0-beta](https://github.com/fxamacker/cbor/releases/tag/v2.5.0-beta) (Dec 2022) -> [v2.5.0](https://github.com/fxamacker/cbor/releases/tag/v2.5.0) (Aug 2023).
456
469
457
470
__IMPORTANT__: 👉 Before upgrading from v2.4 or older release, please read the notable changes highlighted in the release notes. v2.5.0 is a large release with bug fixes to error handling for extraneous data in `Unmarshal`, etc. that should be reviewed before upgrading.
@@ -654,7 +667,7 @@ This library uses `x448/float16` which used to be included. As a standalone pac
0 commit comments