add example about utility method for making a client

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
ramonpetgrave64 · May 21, 2024 · 97ea5f8 · 97ea5f8
1 parent 56b68af
commit 97ea5f8
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/API-Library.md b/docs/API-Library.md
@@ -58,6 +58,8 @@ func doVerify() (*apiUtils.TrustedBuilderID, error) {
 	// opts := sigstoreTUF.DefaultOptions().WithForceCache()
 	// example: supply your own root
 	// opts := sigstoreTUF.DefaultOptions().WithRoot([]byte(`{"signed":{"_type":"root","spec_version":"1.0","version":9,"expires":"2024-09-12T06:53:10Z","keys":{"1e1d65ce98b10 ...`)).WithForceCache()
+	// example: use our uility method for making a client
+	// client, err := apiUtils.NewSigstoreTUFClient()
 	opts := sigstoreTUF.DefaultOptions()
 	client, err := sigstoreTUF.New(opts)
 	if err != nil {