Skip to content
This repository was archived by the owner on Aug 20, 2026. It is now read-only.

Commit d112156

Browse files
committed
docs: add CI badge and dependency graph to README
1 parent 8110afe commit d112156

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,29 @@
11
# byte-codec
22

3-
[![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/byte-codec) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/byte-codec) [![Release](https://img.shields.io/github/v/release/ExaDev/byte-codec)](https://github.com/ExaDev/byte-codec/releases/latest)
3+
[![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/byte-codec) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/byte-codec) [![Release](https://img.shields.io/github/v/release/ExaDev/byte-codec)](https://github.com/ExaDev/byte-codec/releases/latest) [![CI](https://img.shields.io/github/actions/workflow/status/ExaDev/byte-codec/ci.yml?branch=main)](https://github.com/ExaDev/byte-codec/actions)
44

55
> Generic byte-level primitives (ByteWriter, ByteReader, CRC-32, deflate/inflate) and PNG/JPEG image encoding/decoding with zero PDF knowledge — the shared utility package for the documents.js family.
66
77
Extracted from [pdf-codec](https://github.com/ExaDev/pdf-codec), where these utilities lived as a directory-isolated subgraph under `src/bytes/` + `src/image/` with no PDF imports. Both pdf-codec and documents.js consume them from this neutral home rather than one fetching byte utilities from a backend.
88

9+
byte-codec has no internal dependencies in the documents.js family — its only external dependency is [`fflate`](https://github.com/101arrowz/fflate) for raw DEFLATE/zlib compression. Both [pdf-codec](https://github.com/ExaDev/pdf-codec) and [documents.js](https://github.com/ExaDev/documents.js) depend on it:
10+
11+
```mermaid
12+
graph TD
13+
bytecodec("byte-codec")
14+
pdfcodec("pdf-codec")
15+
documents("documents.js")
16+
17+
bytecodec --> pdfcodec
18+
bytecodec --> documents
19+
20+
click bytecodec "https://github.com/ExaDev/byte-codec" "byte-codec"
21+
click pdfcodec "https://github.com/ExaDev/pdf-codec" "pdf-codec"
22+
click documents "https://github.com/ExaDev/documents.js" "documents.js"
23+
24+
style bytecodec fill:#f9a825,stroke:#333,stroke-width:3px
25+
```
26+
927
## Getting started
1028

1129
Requires Node.js `>=20` and pnpm `11.6.0`.

0 commit comments

Comments
 (0)