diff --git a/README.md b/README.md index 33b2690..b9e8e65 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,18 @@ Note that by repository state I mean the actual state of a repository at a given The current trust level is defined as looking legitimate, I don't guarantee that to the best of my knowledge there isn't any security vulnerability. Meta-informations related to a git, such as dependencies (not the legitimate aspect but the verified one), issues, pull requests..., aren't verified yet but may be in the future, if so it would be precised as such. + +Default template: + +```json +{ + // Mandatory: git state hash verified. + "commit": "0123456789abcdef0123456789abcdef01234567", + // Optional (default: "VERIFIED"): xor of following flags (written as `FLAG_0 | FLAG_1 | ... | FLAG_N`): + // - `CLOSED_SOURCE_DEPENDENCY` + // - `UNVERIFIED_INITIAL_COMMIT` + "status": "VERIFIED", + // Optional (default: ""): verifier comment concerning the git state verified + "comment": "" +} +```