Skip to content
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.

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

Formally specify the binary format #4

Open
lilnasy opened this issue Jul 11, 2023 · 0 comments
Open

Formally specify the binary format #4

lilnasy opened this issue Jul 11, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@lilnasy
Copy link
Owner

lilnasy commented Jul 11, 2023

A contributor, or a potential user shouldn't have to read code to understand the binary format that es-codec uses.

It would be valuable have a document detailing what the byte representation of each type looks like.

This should allow contributors to quickly get started, point out issues, check for correctness, and potentially implement a better version independently.

@lilnasy lilnasy added the documentation Improvements or additions to documentation label Jul 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant