Skip to content

Commit 1f67e1e

Browse files
authored
Merge pull request #489 from fxamacker/fxamacker/require-go-1.17-in-go.mod
Update go.mod to require go 1.17. Update Quick Start to define CBOR data item and CBOR sequence.
2 parents d81df7a + 793a058 commit 1f67e1e

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ CBOR is a [trusted alternative](https://www.rfc-editor.org/rfc/rfc8949.html#name
88

99
`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).
1010

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.
1212

1313
## fxamacker/cbor
1414

@@ -219,6 +219,13 @@ __Install__: `go get github.com/fxamacker/cbor/v2` and `import "github.com/fxama
219219

220220
### Key Points
221221

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+
222229
- Encoding and decoding modes are created from options (settings).
223230
- Modes can be created at startup and reused.
224231
- Modes are safe for concurrent use.
@@ -452,6 +459,12 @@ Default limits may need to be increased for systems handling very large data (e.
452459

453460
## Status
454461

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+
455468
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).
456469

457470
__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
654667

655668
## License
656669

657-
Copyright © 2019-2023 [Faye Amacker](https://github.com/fxamacker).
670+
Copyright © 2019-2024 [Faye Amacker](https://github.com/fxamacker).
658671

659672
fxamacker/cbor is licensed under the MIT License. See [LICENSE](LICENSE) for the full license text.
660673

go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module github.com/fxamacker/cbor/v2
22

3-
go 1.20
3+
go 1.17 // Compiling with go 1.20+ uses new features and optimizations
44

55
require github.com/x448/float16 v0.8.4

0 commit comments

Comments
 (0)