opentimestamps: add help text.

wader · Sep 26, 2023 · 912f411 · 912f411
1 parent 64a4ff2
commit 912f411
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/format/opentimestamps/ots.go → format/opentimestamps/opentimestamps.go b/format/opentimestamps/ots.go → format/opentimestamps/opentimestamps.go
@@ -3,13 +3,18 @@ package opentimestamps
 // https://opentimestamps.org/
 
 import (
+	"embed"
+
 	"github.com/wader/fq/format"
 	"github.com/wader/fq/pkg/decode"
 	"github.com/wader/fq/pkg/interp"
 	"github.com/wader/fq/pkg/scalar"
 	"golang.org/x/exp/slices"
 )
 
+//go:embed opentimestamps.md
+var otsFS embed.FS
+
 func init() {
 	interp.RegisterFormat(
 		format.Opentimestamps,
@@ -18,6 +23,7 @@ func init() {
 			DecodeFn:    decodeOTSFile,
 			Groups:      []*decode.Group{format.Probe},
 		})
+	interp.RegisterFS(otsFS)
 }
 
 const (

diff --git a/format/opentimestamps/opentimestamps.md b/format/opentimestamps/opentimestamps.md
@@ -0,0 +1,24 @@
+### View a full OpenTimestamps file
+
+```
+$ fq dd file.ots
+```
+
+### List the names of the Calendar servers used
+
+```
+$ fq '.operations | map(select(.attestation_type == "calendar") | .url)' file.ots
+```
+
+### Check if there are Bitcoin attestations present
+
+```
+$ fq '.operations | map(select(.attestation_type == "bitcoin")) | length > 0' file.ots
+```
+
+### Authors
+- fiatjaf, https://fiatjaf.com
+
+### References
+- https://opentimestamps.org/
+- https://github.com/opentimestamps/python-opentimestamps