Skip to content

Commit fb5a760

Browse files
michaeldboydmichaeldboyd
authored
Trust Registry Service and New Doc Hierarchy (#169)
* first * added credential templates docs * consolidated to provider service * new outline of structure * changed intro * split out concepts * added sdk specific repos * updated nav * added new structure to docs * minor updates and typos * add basic trust registry commands * change header Co-authored-by: Michael Boyd <[email protected]>
1 parent 1c27ef3 commit fb5a760

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+852
-405
lines changed

‎cli/src/cli.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,10 +346,10 @@ subcommands:
346346
- invitation_status:
347347
about: "Check invitation status"
348348
version: "0.1"
349-
- create_credential_template:
349+
- create-credential-template:
350350
about: "Create credential template"
351351
version: "0.1"
352-
- list_credential_templates:
352+
- list-credential-templates:
353353
about: "List credential templates"
354354
version: "0.1"
355355
- trust-registry:

‎docs/_static/extra.css‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
h1, h2, h3 {
2+
font-weight: 800;
3+
}
4+
15
.md-header {
26
/* background-color: #333; */
37
box-shadow: none !important;

‎docs/_static/images/trust-triangle.png‎

139 KB
Loading

‎docs/android/index.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# The Trinsic Java / Android SDK
2+
3+
The Trinsic Java / Android SDK makes it easy to interact with the Trinsic API from any Java application. The most recent version of the library can be found on ____. You can find the SDKs source on [Github](https://github.com/trinsic-id/sdk/java).
4+
5+
## Installation
6+
TODO
7+
8+
## Configuration
9+
TODO
10+
11+
## Next Steps
12+
TODO
13+

‎docs/cli/index.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# The Trinsic CLI
2+
3+
The Trinsic CLI makes it easy to interact with the Trinsic API from your terminal. You can get the CLI on homebrew or build the CLI from source on [Github](https://github.com/trinsic-id/sdk/cli. It contains all the commands of Trinsic's SDKs and makes them interactive.
4+
5+
## Installation
6+
7+
The CLI can be installed directly as binary or built from source.
8+
### Using Homebrew for MacOS and Linux
9+
10+
```
11+
brew tap trinsic-id/trinsic
12+
brew install trinsic
13+
```
14+
15+
### From source using the Rust toolchain
16+
17+
This requires the [Rustup toolchain :material-open-in-new:](https://www.rust-lang.org/tools/install){target=_blank} installed on your system.
18+
19+
Once installed, run this command in terminal:
20+
21+
```bash
22+
cargo +nightly install --git https://github.com/trinsic-id/sdk trinsic
23+
```
24+
25+
To verify that the CLI has been installed successfully, try running:
26+
27+
```bash
28+
trinsic --help
29+
```
30+
31+
## Configuration
32+
33+
The CLI stores its configuration in the user's home directory in `~/.trinsic/`. This directory contains the main configuration file `config.toml` and all the profile data.
34+
35+
### Show Configuration
36+
37+
To print the current configuration file in the terminal use:
38+
39+
```bash
40+
trinsic config --show
41+
```
42+
43+
Typical configuration file may look like this:
44+
45+
```toml
46+
[server]
47+
address = "http://localhost:5000/"
48+
49+
[profile]
50+
default = "my_profile"
51+
```
52+
53+
### Update Configuration Entry
54+
55+
To change the configuration values, use the `config` subcommand with the attribute and it's value.
56+
57+
```bash
58+
trinsic config <attribute_name> <attribute_value>
59+
```
60+
61+
The following attributes are currently supported:
62+
63+
`server-address`
64+
: Updates the default server address the CLI communicates
65+
66+
```bash
67+
trinsic config --server-address https://example.com/
68+
```
69+
70+
`profile-default`
71+
: Updates the default profile used with the CLI
72+
73+
```bash
74+
trinsic config --profile-default alice
75+
```
76+
77+
## Next Steps
78+
79+
Once the CLI is installed and configured, you're ready to start building! We recommend going through the [walkthrough](./vaccination-cli.md) next. If you're ready to dive into building your ecosystem, check out our [API Reference](/reference/index.md)
80+
81+
[Start Walkthrough](./vaccination-cli.md){ .md-button .md-button--primary } [Explore API](/reference/index.md){ .md-button }
82+

‎docs/walkthrough/vaccination-cli.md‎ renamed to ‎docs/cli/vaccination-cli.md‎

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,10 @@
33
It can be challenging to understand how verifiable credentials work until you see some examples. This walkthrough will show how a vaccination card might be issued, held, and proven using verifiable credentials with the Trinsic CLI. It assumes no prior knowledge to decentralized identity.
44

55
--8<----
6-
walkthrough/snippets/intro-infrastructure.md
7-
walkthrough/snippets/intro-use-case.md
6+
/snippets/intro-infrastructure.md
7+
/snippets/intro-use-case.md
88
--8<----
99

10-
## Install Trinsic CLI
11-
12-
--8<-- "setup/installation/install-cli.md"
13-
14-
If you're here to just go through the walkthrough, check out our [Gitpod cloud environment](https://gitpod.io/#https://github.com/trinsic-id/sdk) for easy installation (You'll have to create a free account with gitpod).
15-
16-
To install the CLI locally, clone our sdk github repo and compile the SDK
17-
```bash
18-
git clone https://github.com/trinsic-id/sdk.git
19-
20-
cd sdk/cli
21-
22-
cargo install --path .
23-
```
24-
25-
Once installed, configure the CLI's server address to your Ecosystem:
26-
27-
=== "Trinsic CLI"
28-
29-
```bash
30-
trinsic config --server-address https://example.com
31-
```
32-
33-
!!! note
34-
Reference: [Configuration with CLI](../reference/setup/index.md#configuration-with-cli)
3510

3611
## Meet Allison
3712

‎docs/concepts/index.md‎

Lines changed: 0 additions & 61 deletions
This file was deleted.

‎docs/dotnet/index.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# The Trinsic C# / .NET SDK
2+
The Trinsic C# / .NET SDK makes it easy to interact with the Trinsic API from your .NET application. The most recent version of the library can be found on NuGet. The Trinsic SDK supports .NET applications written in C#, VB.NET, and F# that utilize any supported version of .NET Core. You can also find the SDKs source on [Github](https://github.com/trinsic-id/sdk/dotnet).
3+
4+
## Installation
5+
Install the packages directly from [Nuget.org :material-open-in-new:](https://www.nuget.org/packages/Trinsic){target=_blank}
6+
7+
=== "Package Manager"
8+
```
9+
PM> Install-Package Trinsic
10+
```
11+
=== ".NET CLI"
12+
```
13+
> dotnet add package Trinsic
14+
```
15+
=== "PackageReference"
16+
```
17+
<PackageReference Include="Trinsic" />
18+
```
19+
20+
## Configuration
21+
22+
```csharp
23+
using Trinsic;
24+
25+
// Set the server address
26+
var service = new WalletService("https://example.com");
27+
28+
// Create new profile or import an existing one
29+
var myProfile = await service.CreateWallet();
30+
31+
// Set the profile to be used with authorization pipeline
32+
service.SetProfile(myProfile);
33+
```
34+
35+
## Next Steps
36+
37+
Once the CLI is installed and configured, you're ready to start building! We recommend going through the [walkthrough](./vaccination-net.md) next. If you're ready to dive into building your ecosystem, check out our [API Reference](/reference/index.md)
38+
39+
[Start Walkthrough](./vaccination-net.md){ .md-button .md-button--primary } [Explore API](/reference/index.md){ .md-button }
40+

‎docs/walkthrough/vaccination-net.md‎ renamed to ‎docs/dotnet/vaccination-net.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Vaccination Use Case for .NET Core
22

33
--8<----
4-
walkthrough/snippets/intro-infrastructure.md
5-
walkthrough/snippets/intro-use-case.md
4+
/snippets/intro-infrastructure.md
5+
/snippets/intro-use-case.md
66
--8<----
77

88
## Technical requirements
@@ -65,7 +65,7 @@ File.WriteAllBytes("allison.bin", allison.ToByteString().ToByteArray());
6565
var allison = WalletProfile.Parser.ParseFrom(File.ReadAllBytes("allison.bin"));
6666
```
6767

68-
Read more about [security profiles](/reference/setup/#authorization) and authentication.
68+
Read more about [security profiles](/reference/#authorization) and authentication.
6969

7070
## Certificate issuance
7171

‎docs/early-adopter.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
# Introducing Trinsic Ecosystems
1+
# Introducing Trinsic v2
2+
For development teams ready to integrate verifiable credentials for an industry or use case, Trinsic v2 has been built specifically for you. We're currently in beta with a small group of customers.
23

3-
For organizations ready to deploy verifiable credentials into a complex industry or use case, Trinsic has prepared tools to help you do so.
4+
If you'd like to experiment with our SDKs, please reach out! Simply fill out the form below, and we'll get in touch.
45

5-
To learn more about Trinsic Ecosystems, read our announcement about it:
6+
<div class="_form_19"></div><script src="https://streetcred.activehosted.com/f/embed.php?id=19" type="text/javascript" charset="utf-8"></script>
67

7-
[Announcing Trinsic Ecosystems](https://trinsic.id/introducing-trinsic-ecosystems/)
8-
9-
<div class="_form_19"></div><script src="https://streetcred.activehosted.com/f/embed.php?id=19" type="text/javascript" charset="utf-8"></script>
8+
To learn more about Trinsic v2, read our [announcement](https://trinsic.id/introducing-trinsic-ecosystems/), and continue exploring our docs.

0 commit comments

Comments
 (0)