From 14db893cad01b8e2f416a036ff682872a3790da2 Mon Sep 17 00:00:00 2001
From: Faye Amacker <33205765+fxamacker@users.noreply.github.com>
Date: Sun, 6 Aug 2023 18:14:07 -0500
Subject: [PATCH] Update README.md
Remove "CBOR Options" section.
This info can be found in the docs and it looks like it was outdated here.
---
README.md | 42 ------------------------------------------
1 file changed, 42 deletions(-)
diff --git a/README.md b/README.md
index a7ab4a9f..7fba68ba 100644
--- a/README.md
+++ b/README.md
@@ -316,44 +316,6 @@ Github reports [2000+ repositories](https://github.com/fxamacker/cbor/network/de
`fxamacker/cbor` passed multiple confidential security assessments. A [nonconfidential security assessment](https://github.com/veraison/go-cose/blob/v1.0.0-rc.1/reports/NCC_Microsoft-go-cose-Report_2022-05-26_v1.0.pdf) (prepared by NCC Group for Microsoft Corporation) includes a subset of fxamacker/cbor v2.4.0 in its scope.
-## CBOR Options
-
-### Encoding Options
-
-Integers always encode to the shortest form that preserves value. By default, time values are encoded without tags.
-
-Encoding of other data types and map key sort order are determined by encoder options.
-
-| EncOptions | Available Settings (defaults listed first)
-| :--- | :--- |
-| Sort | **SortNone**, SortLengthFirst, SortBytewiseLexical
Aliases: SortCanonical, SortCTAP2, SortCoreDeterministic |
-| Time | **TimeUnix**, TimeUnixMicro, TimeUnixDynamic, TimeRFC3339, TimeRFC3339Nano |
-| TimeTag | **EncTagNone**, EncTagRequired |
-| ShortestFloat | **ShortestFloatNone**, ShortestFloat16 |
-| BigIntConvert | **BigIntConvertShortest**, BigIntConvertNone |
-| InfConvert | **InfConvertFloat16**, InfConvertNone |
-| NaNConvert | **NaNConvert7e00**, NaNConvertNone, NaNConvertQuiet, NaNConvertPreserveSignal |
-| IndefLength | **IndefLengthAllowed**, IndefLengthForbidden |
-| TagsMd | **TagsAllowed**, TagsForbidden |
-
-See [Options](#options) section for details about each setting.
-
-### Decoding Options
-
-| DecOptions | Available Settings (defaults listed first) |
-| :--- | :--- |
-| TimeTag | **DecTagIgnored**, DecTagOptional, DecTagRequired |
-| DupMapKey | **DupMapKeyQuiet**, DupMapKeyEnforcedAPF |
-| IntDec | **IntDecConvertNone**, IntDecConvertSigned |
-| IndefLength | **IndefLengthAllowed**, IndefLengthForbidden |
-| TagsMd | **TagsAllowed**, TagsForbidden |
-| ExtraReturnErrors | **ExtraDecErrorNone**, ExtraDecErrorUnknownField |
-| MaxNestedLevels | **32**, can be set to [4, 65535] |
-| MaxArrayElements | **131072**, can be set to [16, 2147483647] |
-| MaxMapPairs | **131072**, can be set to [16, 2147483647] |
-
-See [Options](#options) section for details about each setting.
-
## Standards
This library is a full-featured generic CBOR [(RFC 8949)](https://tools.ietf.org/html/rfc8949) encoder and decoder. Notable CBOR features include:
@@ -368,8 +330,6 @@ This library is a full-featured generic CBOR [(RFC 8949)](https://tools.ietf.org
| Basic validity checks | Check UTF-8 validity and optionally check duplicate map keys. |
| Security considerations | Prevent integer overflow and resource exhaustion (RFC 8949 Section 10). |
-See the Features section for list of [Encoding Options](#encoding-options) and [Decoding Options](#decoding-options).
-
Known limitations are noted in the [Limitations section](#limitations).
Go nil values for slices, maps, pointers, etc. are encoded as CBOR null. Empty slices, maps, etc. are encoded as empty CBOR arrays and maps.
@@ -385,8 +345,6 @@ When decoding well-formed CBOR arrays and maps, decoder saves the first error it
By default, decoder treats time values of floating-point NaN and Infinity as if they are CBOR Null or CBOR Undefined.
-See [Options](#options) section for detailed settings or [Features](#features) section for a summary of options.
-
__Click to expand topic:__