Skip to content

Commit

Permalink
Installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tmarkovski committed Jun 1, 2021
1 parent bcc3c5c commit 8522ef9
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 84 deletions.
82 changes: 0 additions & 82 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,85 +3,3 @@
This document described the available features in the Trinsic SDK. The SDK is available as package for most languages, as well as a CLI. Both the SDK and CLI have idential functionality, though differ slightly in how they operate with configuration and structured data.

## Using SDK vs CLI

## Wallet Commands

### `create` subcommand

This subcommand creates a new wallet and stores the profile with the given name. If the profile name exists, it will be overwritten.

```bash
okapi wallet create --name alice --description "Alice's Cloud Wallet" --default
```

The flag `--default` is optional. If specified, it will also set the configuration to use this profile as default. The first profile created, will be set as default, regardless of the flag.

To see all available flags and options for this subcommand

=== "CLI"
```bash
okapi wallet create --help
```
=== "JS"

```js
var string = "hello world";
```

=== "C#"

```csharp
int tmp = 2;
```

## Credential Service
//TODO - add each section
=== "CLI"

```bash
trinsic issuer issue --document ./covid-vocab/vaccination-certificate-unsigned.jsonld --out ./covid-vocab/vaccination-certificate-signed.jsonld
```
=== "JS"

```js
var string = "hello world";
```

=== "C#"

```csharp
int tmp = 2;
```

## Provider Service


## Command Reference
- didkey
- generate
- resolve

- didcomm
- pack
- unpack
- verify
- sign

- config

- wallet
- get_provider_configuration
- create
- set_profile
- search
- insert_item
- grant_access
- revoke_access

- issuer
- issue
- create_proof
- verify_proof

- authentication
- acquire_token
44 changes: 44 additions & 0 deletions docs/reference/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Installation

## Trinsic CLI

The CLI can be installed directly using the Cargo tool. This requires the [Rustup toolchain :material-open-in-new:](https://www.rust-lang.org/tools/install){target=_blank} installed on your system.

Once installed, run this command in terminal:

=== "Terminal"
```bash
cargo install --git https://github.com/trinsic-id/sdk.git
```

To verify that the CLI has been installed successfully, try running:

=== "Terminal"
```bash
trinsic --help
```
## .NET Core

Install the packages directly from [Nuget.org :material-open-in-new:](https://www.nuget.org/packages/Trinsic){target=_blank}

=== "Package Manager"
```
PM> Install-Package Trinsic
```
=== ".NET CLI"
```
> dotnet add package Trinsic
```
=== "PackageReference"
```
<PackageReference Include="Trinsic" />
```

## NPM

Install the package for Node or Browser from [npmjs.com :material-open-in-new:](https://www.npmjs.com/package/@trinsic/trinsic){target=_blank}

=== "Install"
```bash
npm i @trinsic/trinsic
```
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ nav:
- Introduction: index.md
- Walkthrough: walkthrough.md
- Reference:
- Introduction: reference/index.md
- SDK Concepts:
- Overview: reference/index.md
- Installation: reference/installation.md
- Concepts:
- Security Profiles: reference/profiles.md
- Configuration: reference/configuration.md
- Services:
Expand Down

0 comments on commit 8522ef9

Please sign in to comment.