Skip to content

Commit

Permalink
docs: go Getting Started & Selective Disclosure Attribution documenta…
Browse files Browse the repository at this point in the history
…tion are wrong (#1301)

Co-authored-by: Joshua Coffey <[email protected]>
  • Loading branch information
lucasamonrc and geel9 authored Mar 1, 2023
1 parent 7599bf4 commit 07636c1
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
23 changes: 13 additions & 10 deletions docs/go/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,21 @@ The Trinsic Go SDK makes it easy to interact with the Trinsic API from any Go ap
You have to go to the [other downloads](https://go.dev/dl/) page to get the `arm64` version for sure.

* NOTE: Windows installation is possible, but requires jumping through a few hoops. More details to come later.
* Make sure you have the okapi native binaries installed on your machine. Default installation instructions are in the [readme.md here](https://github.com/trinsic-id/okapi/)
* You need to have [CGO configured](https://pkg.go.dev/cmd/cgo) for the okapi native binary link
* Issue the following command:
!!! info "Notes: Installing the SDK for Go"

- Windows installation is possible, but requires jumping through a few hoops. More details to come later.
- Make sure you have the okapi native binaries installed on your machine. Default installation instructions are in the [trinsic-id/okapi](https://github.com/trinsic-id/okapi/) GitHub repository.
- You need to have [CGO configured](https://pkg.go.dev/cmd/cgo) for the okapi native binary link.

1. Run the following command:
```bash
go install github.com/trinsic-id/sdk/go@latest
```
* To test the installation, try the following go code:
<!--codeinclude-->
```golang
[GoSample](../../samples/go/sample.go) inside_block:main
```
2. Test the installation by running the following go code:
<!--codeinclude-->
```golang
[GoSample](../../samples/go/sample.go) inside_block:main
```
<!--/codeinclude-->

## Next Steps
Expand Down Expand Up @@ -59,4 +62,4 @@ go/pkg/mod/github.com/trinsic-id/okapi/[email protected]/okapi/didcomm.go:22:9: undefine
Try running with the following env var set:
```bash
CGO_ENABLED=1 go test ./...
```
```
2 changes: 1 addition & 1 deletion docs/reference/services/credential-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ Creates and signs a [proof](/) for a valid JSON-LD credential, using the BBS+ Si
If the credential is stored in a Trinsic cloud wallet, pass its `item_id`; otherwise, pass the raw JSON-LD credential via `document_json`.

!!! info "Selective Disclosure"
BBS+ Signatures support the ability to generate a proof for a subset of a credential's fields, instead of every field.
BBS+ Signatures support the ability to generate a proof for a subset of a credential's fields, instead of every field.

This enables increased user privacy: fields which aren't included in `reveal_document_json` will not be present in the generated proof.

Expand Down

0 comments on commit 07636c1

Please sign in to comment.