Skip to content

Commit

Permalink
docs: fix docusaurus (#213)
Browse files Browse the repository at this point in the history
Signed-off-by: Allain Magyar <allain.magyar@iohk.io>
  • Loading branch information
amagyar-iohk committed May 8, 2024
1 parent f0c655f commit 4e90062
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 13 deletions.
18 changes: 7 additions & 11 deletions docs/sdk/README.md → docs/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
# Atala PRISM TypeScript SDK
# Identus TypeScript SDK

[![Coverage Status](https://coveralls.io/repos/github/input-output-hk/atala-prism-wallet-sdk-ts/badge.svg?branch=master)](https://coveralls.io/github/input-output-hk/atala-prism-wallet-sdk-ts?branch=master)

<p align="center">
<img src="atala-logo.png" alt="Atala logo" width="300"/>
</p>

---

Atala PRISM is a self-sovereign identity (SSI) platform and service suite for
Identus is a self-sovereign identity (SSI) platform and service suite for
verifiable data and digital identity. Built on Cardano, it offers core
infrastructure for issuing DIDs (Decentralized identifiers) and verifiable
credentials, alongside tools and frameworks to help expand your ecosystem.
The complete platform is separated into multiple repositories:

- [atala-prism-wallet-sdk-swift](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift) - Repo that implements Atala PRISM for Apple platforms in Swift.
- [atala-prism-wallet-sdk-kmm](https://github.com/input-output-hk/atala-prism-wallet-sdk-kmm) - Repo that implements Atala PRISM for Apple platforms in KMM, JVM.
- [atala-prism-wallet-sdk-ts](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts) - Repo that implements Atala PRISM for Browser and NodeJS platforms in TypeScript.
- [atala-prism-building-blocks](https://github.com/hyperledger-labs/open-enterprise-agent) - Repo that contains the servers Building Blocks.
- [atala-prism-mediator](https://github.com/input-output-hk/atala-prism-mediator) - Repo for DIDComm V2 Mediator
- [edge-agent-sdk-swift](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift) - Repo that implements Atala PRISM for Apple platforms in Swift.
- [edge-agent-sdk-kmm](https://github.com/input-output-hk/atala-prism-wallet-sdk-kmm) - Repo that implements Atala PRISM for Apple platforms in KMM, JVM.
- [edge-agent-sdk-ts](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts) - Repo that implements Atala PRISM for Browser and NodeJS platforms in TypeScript.
- [edge-agent-building-blocks](https://github.com/hyperledger-labs/open-enterprise-agent) - Repo that contains the servers Building Blocks.
- [edge-agent-mediator](https://github.com/input-output-hk/atala-prism-mediator) - Repo for DIDComm V2 Mediator

## SDK Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const sidebars = {
{
label: 'Introduction',
type: "doc",
id: "sdk/README"
id: "README"
},
{
type: 'category',
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@
"test": "jest",
"coverage": "npm run test -- --coverage",
"lint": "npx eslint .",
"docs": "npx typedoc --options typedoc.js --hideGenerator"
"docs": "npm run docs:readme; npm run docs:typedoc",
"docs:typedoc": "npx typedoc --options typedoc.js --hideGenerator",
"docs:readme": "cp README.md docs/README.md"
},
"author": "IOHK",
"repository": {
Expand Down

0 comments on commit 4e90062

Please sign in to comment.