Skip to content

docs: Add CBOR specification support matrix to README #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Beaudidly merged 1 commit into from
Aug 7, 2025
Merged

docs: Add CBOR specification support matrix to README #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@

A CBOR encoding/decoding library for Gleam.

# Specification Support

This library aims to support the majority of the CBOR specification (RFC 8949). The following table details the level of support for each major feature:

| Feature | Supported | Notes |
| :--- | :---: | :--- |
| Integers | ✅ | Covers both positive (major type 0) and negative (major type 1) integers. |
| Byte Strings | ✅ | Definite-length only (major type 2). |
| Text Strings | ✅ | Definite-length only (major type 3). |
| Arrays | ✅ | Definite-length only (major type 4). |
| Maps | ✅ | Definite-length only (major type 5). |
| Tags | ✅ | (major type 6). |
| Simple Values & Floats | ✅ | Covers simple values, booleans, null, undefined, and floating-point numbers (major type 7). |
| Indefinite-length Items | ❌ | Not supported for strings, byte strings, arrays, or maps. |

# Installation
```sh
gleam add gbor@1
Expand Down