sdbd-demo.git

commit

e6bf4dc

parent

b7ebbd9

author

CheddarCrisp

date

2024-01-11 17:09:22 +0100 CET

Add README and LICENSE

 1@@ -0,0 +1,21 @@
 2+MIT License
 3+
 4+Copyright (c) 2024
 5+
 6+Permission is hereby granted, free of charge, to any person obtaining a copy
 7+of this software and associated documentation files (the "Software"), to deal
 8+in the Software without restriction, including without limitation the rights
 9+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+copies of the Software, and to permit persons to whom the Software is
11+furnished to do so, subject to the following conditions:
12+
13+The above copyright notice and this permission notice shall be included in all
14+copies or substantial portions of the Software.
15+
16+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+SOFTWARE.

 1@@ -0,0 +1,9 @@
 2+# Self-Described Binary Document Proof of Concept
 3+
 4+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.
 5+
 6+## Issues
 7+1. The `Document` data type violates some of the requirements set for metadata header lists.
 8+2. It has at least one securiy issue in that `content-name` is not checked for being a valid filename.
 9+3. It doesn't do much useful.
10+4. It implements version 1 of the format which really needs to be worked into a version 2 before wide-spread use.