feat: docs
All checks were successful
Release to Production / build_and_release (push) Successful in 30s

This commit is contained in:
_ 2025-03-07 14:55:15 +00:00
parent 30dcc722b1
commit ecbcd9141f
3 changed files with 27 additions and 4 deletions

View File

@ -2,12 +2,12 @@
## Nostr Event
This event is designed to provide clarity (when signing) about the agreement being created. It is NOT published to a relay (instead, it is saved in an encrypted zip).
This event is designed to provide clarity (when signing) about the agreement being created. It is NOT published to a relay - instead, it is saved in an encrypted zip.
```json
{
"kind": 160300,
"content": "You are signing an Agreement Template for the following npubs:\n- npub1\n- npub2\n\nEnsure this event is sourced from a trusted SIGit instance.",
"content": "You are creating an Agreement between the following npubs:\n- npub1\n- npub2\n\nEnsure this event is sourced from a trusted SIGit instance.",
"created_at": 1716564780,
"id": "...",
"sig": "...",

View File

@ -77,7 +77,7 @@ sequenceDiagram
Note left of D: Payload is an empty string or<br> an encrypted (and detailed)<br> error message
Note over W: Verify DVM pubkey, <br> event.created_at,<br>event.id
W->>U: User is automatically logged in
Note over W: Ephemeral key is destroyed<br>Default relay list is broadcast<br> using the user pubkey
Note over W: Ephemeral key is destroyed<br>Default relay list is broadcast<br> using actual user pubkey
```

25
sign.md
View File

@ -1 +1,24 @@
# Sign
# Sign
SIGits can be signed in any order.
## Nostr Event
This event is designed to provide clarity (when signing) about the agreement being created. It is NOT published to a relay - instead, it is saved in an encrypted zip.
```json
{
"kind": 1603,
"content": "You are signing an Agreement Template for the following npubs:\n- npub1\n- npub2\n\nEnsure this event is sourced from a trusted SIGit instance.",
"created_at": 1716564780,
"id": "...",
"sig": "...",
"pubkey": "pubkey of CREATOR",
"tags":[
["signers","npub1d0csynr..","npub1nqulz.."],
["viewers","npub1viewer1"], // optional tag, only if there are viewers
["files","hash1:name1.csv","hash2:name2.pdf"], // extension determines the file type. Order determines index.
["meta","hash1"] // the hash of the meta.json file
]
}
```