Add README and LICENSE

This commit is contained in:
CheddarCrisp 2024-01-11 11:09:22 -05:00
parent b7ebbd9169
commit e6bf4dc61f
2 changed files with 30 additions and 0 deletions

9
README.md Normal file
View file

@ -0,0 +1,9 @@
# Self-Described Binary Document Proof of Concept
This repo contains a proof of concept/demo code that implements the Self-Described Binary Document format. This format is described in a series of blog posts starting at https://crispbyte.dev/blog/2024-01-07-01-SDBD/. This code is most definitely not production ready.
## Issues
1. The `Document` data type violates some of the requirements set for metadata header lists.
2. It has at least one securiy issue in that `content-name` is not checked for being a valid filename.
3. It doesn't do much useful.
4. It implements version 1 of the format which really needs to be worked into a version 2 before wide-spread use.