From 8522ef9c09f43f43af4d80556259fdc9134a64c8 Mon Sep 17 00:00:00 2001 From: Tomislav Markovski Date: Tue, 1 Jun 2021 11:26:28 -0400 Subject: [PATCH] Installation docs --- docs/reference/index.md | 82 ---------------------------------- docs/reference/installation.md | 44 ++++++++++++++++++ mkdocs.yml | 5 ++- 3 files changed, 47 insertions(+), 84 deletions(-) create mode 100644 docs/reference/installation.md diff --git a/docs/reference/index.md b/docs/reference/index.md index 057b81f8c..197a315b4 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -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 diff --git a/docs/reference/installation.md b/docs/reference/installation.md new file mode 100644 index 000000000..aa4b7ced1 --- /dev/null +++ b/docs/reference/installation.md @@ -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" + ``` + + ``` + +## 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 + ``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index c20ae99e7..8c66ddecf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: