docker / labs-tape

Tape is for packaging applications
Other
8 stars 1 forks source link

Add a readme #7

Closed errordeveloper closed 1 year ago

errordeveloper commented 1 year ago

It's long overdue! ~I know that more detailed usage examples would be quite good, but I'd leave that for the next PR.~

I'm really keen to hear feedback about the description, whether it's clear enough or a bit too "out there"... Please do keep in mind that this tool is relatively low-level, it's currently for the kind of users who'd otherwise run flux push artifact or possibly go DIY.

errordeveloper commented 1 year ago

@lnovara thank you! I've added a paragraph about the ecosystem, please let me know if it's any good :)

errordeveloper commented 1 year ago

@stefanprodan @slimslenderslacks both of you mentioned that showing OCI JSON manifests would be helpful, I've added an example that shows all that there is. PTAL, whenever you have a chance =)

It's quite verbose, maybe I can use <details/> for some of these JSON objects, but the readme is a bit wordy overall anyway, I wish it to be shorter. Perhaps I can worry about that later.