From b0e0fadae488291441385030dcf1a71cd858fd2a Mon Sep 17 00:00:00 2001 From: Tomislav Markovski Date: Sat, 6 Nov 2021 13:07:01 -0400 Subject: [PATCH] Update readme --- .github/workflows/build-dotnet.yml | 2 +- .github/workflows/build-golang.yml | 2 +- .github/workflows/build-java.yml | 2 +- .github/workflows/build-python.yml | 2 +- .github/workflows/build-ruby.yml | 2 +- .github/workflows/build-rust.yml | 2 +- .github/workflows/build-typescript.yml | 2 +- .gitpod.Dockerfile | 10 ------- .gitpod.yml | 15 ---------- README.md | 38 ++++++++++++++++++-------- 10 files changed, 34 insertions(+), 43 deletions(-) delete mode 100644 .gitpod.Dockerfile delete mode 100644 .gitpod.yml diff --git a/.github/workflows/build-dotnet.yml b/.github/workflows/build-dotnet.yml index c24cd1687..08fc6c17f 100644 --- a/.github/workflows/build-dotnet.yml +++ b/.github/workflows/build-dotnet.yml @@ -1,4 +1,4 @@ -name: ".NET (build)" +name: ".NET" on: pull_request: diff --git a/.github/workflows/build-golang.yml b/.github/workflows/build-golang.yml index 481d43be8..fb819e1a8 100644 --- a/.github/workflows/build-golang.yml +++ b/.github/workflows/build-golang.yml @@ -1,4 +1,4 @@ -name: Golang (build) +name: Go on: workflow_dispatch: diff --git a/.github/workflows/build-java.yml b/.github/workflows/build-java.yml index e2576cab7..9f22db064 100644 --- a/.github/workflows/build-java.yml +++ b/.github/workflows/build-java.yml @@ -1,4 +1,4 @@ -name: Java (build) +name: Java on: workflow_dispatch: diff --git a/.github/workflows/build-python.yml b/.github/workflows/build-python.yml index af4b57c8c..3895d39be 100644 --- a/.github/workflows/build-python.yml +++ b/.github/workflows/build-python.yml @@ -1,4 +1,4 @@ -name: Python (build) +name: Python on: workflow_dispatch: diff --git a/.github/workflows/build-ruby.yml b/.github/workflows/build-ruby.yml index 8734bc987..55460ec5a 100644 --- a/.github/workflows/build-ruby.yml +++ b/.github/workflows/build-ruby.yml @@ -1,4 +1,4 @@ -name: Ruby (build) +name: Ruby on: pull_request: diff --git a/.github/workflows/build-rust.yml b/.github/workflows/build-rust.yml index 1a7bc578c..720763bd5 100644 --- a/.github/workflows/build-rust.yml +++ b/.github/workflows/build-rust.yml @@ -1,4 +1,4 @@ -name: Rust (build) +name: Rust on: pull_request: diff --git a/.github/workflows/build-typescript.yml b/.github/workflows/build-typescript.yml index 2a3a8e963..2cf8b8957 100644 --- a/.github/workflows/build-typescript.yml +++ b/.github/workflows/build-typescript.yml @@ -1,4 +1,4 @@ -name: "TypeScript (build)" +name: "TypeScript" on: pull_request: diff --git a/.gitpod.Dockerfile b/.gitpod.Dockerfile deleted file mode 100644 index 5654a8431..000000000 --- a/.gitpod.Dockerfile +++ /dev/null @@ -1,10 +0,0 @@ -FROM gitpod/workspace-full - -# Gitpod will not rebuild Trinsic's dev image unless *some* change is made to this Dockerfile. -# To force a rebuild, simply increase this counter: -# ENV TRIGGER_REBUILD 3 - -# Custom commands or tools can go here - -RUN brew install mkdocs -RUN pip install mkdocs-material \ No newline at end of file diff --git a/.gitpod.yml b/.gitpod.yml deleted file mode 100644 index cb7bcc83c..000000000 --- a/.gitpod.yml +++ /dev/null @@ -1,15 +0,0 @@ - -image: - file: .gitpod.Dockerfile - -ports: - - port: 5000 - onOpen: open-browser - -tasks: - - command: rustup component add rustfmt && cargo install --path cli - - command: mkdocs serve -a 127.0.0.1:5000 - -vscode: - extensions: - - matklad.rust-analyzer diff --git a/README.md b/README.md index bd4f4c15a..bf06ba9c6 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,35 @@ -# The Trinsic SDK +# Trinsic SDK -[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/trinsic-id/sdk) -[![NET](https://github.com/trinsic-id/sdk/actions/workflows/dotnet.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/dotnet.yml) -[![Rust](https://github.com/trinsic-id/sdk/actions/workflows/rust.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/rust.yml) -[![Node](https://github.com/trinsic-id/sdk/actions/workflows/node.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/node.yml) +[![.NET](https://github.com/trinsic-id/sdk/actions/workflows/build-dotnet.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/build-dotnet.yml) +[![Go](https://github.com/trinsic-id/sdk/actions/workflows/build-golang.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/build-golang.yml) +[![Java](https://github.com/trinsic-id/sdk/actions/workflows/build-java.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/build-java.yml) +[![Python](https://github.com/trinsic-id/sdk/actions/workflows/build-python.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/build-python.yml) +[![Ruby](https://github.com/trinsic-id/sdk/actions/workflows/build-ruby.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/build-ruby.yml) +[![Rust](https://github.com/trinsic-id/sdk/actions/workflows/build-rust.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/build-rust.yml) +[![TypeScript](https://github.com/trinsic-id/sdk/actions/workflows/build-typescript.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions/workflows/build-typescript.yml) -**Only available for beta customers at this time** +## Introduction + +Welcome to Trinsic, the proof-of-anything platform. We are the leading developer platform for implementing [verifiable credentials](https://www.w3.org/TR/vc-data-model/) and [decentralized identifiers](https://www.w3.org/TR/did-core/) - emerging web standards for building next-gen digital identity systems. + +Learn how to issue and verify universally-accepted digital credentials so that anywhere people go online or in-person, they can simply tap their phone, prove who they are, and get what they need. + +## Getting Started + +Check our our [documentation](https://docs-v2.trinsic.id) to learn about Trinsic, work through a basic implementation, plan a full integration, and learn about our tools you can use. + +## Example Implementations + +Check out our [dedicated repository with various examples](https://github.com/trinsic-id/sdk-examples/) and use cases for different platforms and languages. ## Available SDKs - [.NET](https://docs-v2.trinsic.id/dotnet) -- [TypeScript](https://docs-v2.trinsic.id/node) +- [Java / Android](https://docs-v2.trinsic.id/java) +- [Swift](https://docs-v2.trinsic.id/python) +- [TypeScript / Node](https://docs-v2.trinsic.id/node) +- [TypeScript / Browser](https://docs-v2.trinsic.id/node) - [Python](https://docs-v2.trinsic.id/python) +- [Go](https://docs-v2.trinsic.id/go) +- [Ruby](https://docs-v2.trinsic.id/ruby) - [Command Line](https://docs-v2.trinsic.id/cli) - -## Contributing - -Immediately after cloning, do `git submodule update --init --recursive` to initialize and update all dependent submodules.