diff --git a/README.md b/README.md index 7b09408eb..5d923a02a 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,6 @@ This monorepo publishes the core Mesh packages to npm under the `@meshsdk` scope | ------- | ----------- | ---- | | [@meshsdk/core](https://github.com/MeshJS/mesh/tree/main/packages/mesh-core) | The main entry point. Re-exports transactions, wallets, providers and common utilities. | [Playground](https://meshjs.dev/) | | [@meshsdk/transaction](https://github.com/MeshJS/mesh/tree/main/packages/mesh-transaction) | `MeshTxBuilder` for sending assets, minting tokens and interacting with smart contracts | [Docs](https://docs.meshjs.dev/transactions) · [Playground](https://meshjs.dev/apis/txbuilder) | -| [@meshsdk/wallet](https://github.com/MeshJS/mesh/tree/main/packages/mesh-wallet) | Browser (CIP-30) and headless wallets for managing keys, signing and submitting | [Docs](https://docs.meshjs.dev/wallets) · [Playground](https://meshjs.dev/apis/wallets) | | [@meshsdk/contract](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract) | Open-source smart contracts with off-chain transaction code | [Docs](https://docs.meshjs.dev/contracts) · [Playground](https://meshjs.dev/smart-contracts) | | [@meshsdk/common](https://github.com/MeshJS/mesh/tree/main/packages/mesh-common) | Shared constants, types and interfaces used across the SDK | [Docs](https://docs.meshjs.dev/common) | | [@meshsdk/core-cst](https://github.com/MeshJS/mesh/tree/main/packages/mesh-core-cst) | Serialization and utilities built on cardano-js-sdk and Harmonic Labs libraries | [Docs](https://docs.meshjs.dev/core-cst) | @@ -94,6 +93,7 @@ These `@meshsdk` packages are developed in their own repositories: | Package | Description | Repository | | ------- | ----------- | ---------- | +| @meshsdk/wallet | Browser (CIP-30) and headless wallets for managing keys, signing and submitting | [MeshJS/wallet](https://github.com/MeshJS/wallet) | | @meshsdk/provider | Blockchain data providers (Blockfrost, Koios, Maestro, Ogmios and more) | [MeshJS/providers](https://github.com/MeshJS/providers) | | @meshsdk/react | React components and hooks for Cardano wallet connection | [MeshJS/react](https://github.com/MeshJS/react) | | @meshsdk/hydra | Hydra Head protocol client for layer-2 scaling | [MeshJS/hydra](https://github.com/MeshJS/hydra) | @@ -139,7 +139,7 @@ graph TD click core_cst "https://docs.meshjs.dev/core-cst" _parent click provider "https://github.com/MeshJS/providers" _parent click transaction "https://docs.meshjs.dev/transactions" _parent - click wallet "https://docs.meshjs.dev/wallets" _parent + click wallet "https://github.com/MeshJS/wallet" _parent click contract "https://docs.meshjs.dev/contracts" _parent ``` diff --git a/packages/mesh-core/README.md b/packages/mesh-core/README.md index 8ed11d345..20436f6a1 100644 --- a/packages/mesh-core/README.md +++ b/packages/mesh-core/README.md @@ -8,7 +8,7 @@

Mesh TypeScript SDK

-[![Licence](https://img.shields.io/github/license/meshjs/mesh)](https://github.com/meshjs/mesh/blob/master/LICENSE) +[![Licence](https://img.shields.io/github/license/meshjs/mesh)](https://github.com/MeshJS/mesh/blob/main/LICENSE.md) [![Build](https://github.com/meshjs/mesh/actions/workflows/build.yml/badge.svg)](https://github.com/meshjs/mesh/actions/workflows/build.yml) [![Package](https://github.com/meshjs/mesh/actions/workflows/publish.yml/badge.svg)](https://github.com/meshjs/mesh/actions/workflows/publish.yml) @@ -50,19 +50,19 @@ A collection of packages that provide different functionalities to interact with | [@meshsdk/core](https://github.com/MeshJS/mesh/tree/main/packages/mesh-core) | Exports all the functionalities including wallets, transactions, and providers | | [:shipit:](https://meshjs.dev/) | | [@meshsdk/core-csl](https://github.com/MeshJS/mesh/tree/main/packages/mesh-core-csl) | Types and utilities functions between Mesh and cardano-serialization-lib | [:page_facing_up:](https://docs.meshjs.dev/core-csl) | | | [@meshsdk/core-cst](https://github.com/MeshJS/mesh/tree/main/packages/mesh-core-cst) | Types and utilities functions between Mesh and cardano-js-sdk | [:page_facing_up:](https://docs.meshjs.dev/core-cst) | | -| [@meshsdk/provider](https://github.com/MeshJS/mesh/tree/main/packages/mesh-provider) | Blockchain data providers | [:page_facing_up:](https://docs.meshjs.dev/providers) | [:shipit:](https://meshjs.dev/providers) | -| [@meshsdk/react](https://github.com/MeshJS/mesh/tree/main/packages/mesh-react) | React component library | | [:shipit:](https://meshjs.dev/react) | -| [@meshsdk/transaction](https://github.com/MeshJS/mesh/tree/main/packages/mesh-transaction) | Transactions to send assets, mint tokens, and interact with smart contracts | [:page_facing_up:](https://docs.meshjs.dev/transactions) | [:shipit:](https://meshjs.dev/apis/transaction) | -| [@meshsdk/wallet](https://github.com/MeshJS/mesh/tree/main/packages/mesh-wallet) | Wallets to manage assets and interact with the blockchain | [:page_facing_up:](https://docs.meshjs.dev/wallets) | [:shipit:](https://meshjs.dev/apis/wallets) | +| [@meshsdk/provider](https://github.com/MeshJS/providers) | Blockchain data providers | [:page_facing_up:](https://docs.meshjs.dev/providers) | [:shipit:](https://meshjs.dev/providers) | +| [@meshsdk/react](https://github.com/MeshJS/react) | React component library | | [:shipit:](https://meshjs.dev/react) | +| [@meshsdk/transaction](https://github.com/MeshJS/mesh/tree/main/packages/mesh-transaction) | Transactions to send assets, mint tokens, and interact with smart contracts | [:page_facing_up:](https://docs.meshjs.dev/transactions) | [:shipit:](https://meshjs.dev/apis/txbuilder) | +| [@meshsdk/wallet](https://github.com/MeshJS/wallet) | Wallets to manage assets and interact with the blockchain | [:page_facing_up:](https://docs.meshjs.dev/wallets) | [:shipit:](https://meshjs.dev/apis/wallets) | ### Apps Frontend documentation and live demos for Mesh SDK. -| | Description | Website | -| --------------------------------------------------------------------------- | ---------------------------- | ------------------------------------ | -| [apps/docs](https://github.com/MeshJS/mesh/tree/main/apps/docs) | Mesh technical docs | [:shipit:](https://docs.meshjs.dev/) | -| [apps/playground](https://github.com/MeshJS/mesh/tree/main/apps/playground) | Mesh homepage and live demos | [:shipit:](https://meshjs.dev/) | +| | Description | Website | +| ------------------------------------------------------- | ---------------------------- | ------------------------------------ | +| Mesh docs | Mesh technical docs | [:shipit:](https://docs.meshjs.dev/) | +| [MeshJS/meshjs.dev](https://github.com/MeshJS/meshjs.dev) | Mesh homepage and live demos | [:shipit:](https://meshjs.dev/) | ### Mesh Smart Contracts Library