-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dabce06
commit 01f3131
Showing
4 changed files
with
28 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
The **Marlowe TypeScript SDK** is a suite of **TypeScript/JavaScript** libraries for Web Cardano Dapp Development using Marlowe Technologies. | ||
|
||
It is composed of the following packages: | ||
|
||
- Language | ||
- [@marlowe.io/language-core-v1](./modules/_marlowe_io_language_core_v1.html) | ||
- Marlowe Core V1 constructs | ||
- JSON Codec | ||
- Cardano Wallet | ||
- [@marlowe.io/wallet](./modules/_marlowe_io_wallet.html) | ||
- Wallet Extension Capabalities (Browser / CIP-30) | ||
- Single Wallet Address Capabalities(NodeJS / Version used for e2e tests only) | ||
- Runtime | ||
- [@marlowe.io/runtime-lifecycle](./modules/_marlowe_io_runtime_lifecycle.html) : Entry Point for Running remotely Marlowe Contracts over a backend instance of the runtime using a connected wallet. | ||
- Marlowe Tx Commands | ||
- Create | ||
- Applying Inputs | ||
- Withdraws | ||
- Query capabilities for supporting these commands | ||
- [@marlowe.io/runtime-core](./modules/_marlowe_io_runtime_core.html) : core concepts used throughout the runtime libraries. | ||
- [@marlowe.io/runtime-rest-client](./modules/_marlowe_io_runtime_rest_client.html) : client of the runtime rest api. | ||
- Infrastruture Supporting SubDomains | ||
- [@marlowe.io/adapter](./modules/_marlowe_io_adapter.html) : supporting set of libraries for Marlowe and Runtime Core Domains. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# @marlowe.io/runtime-core | ||
|
||
A Set of core functionalities that supports @marlowe.io libraries | ||
|
||
DISCUSSION: What is the difference between this package and the adaptor package? They both seem like utilities packages. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,5 @@ | ||
{ | ||
"$schema": "https://typedoc.org/schema.json", | ||
"entryPointStrategy": "expand", | ||
"entryPoints": ["./src"], | ||
"tsconfig": "./src/tsconfig.json", | ||
"entryPoints": ["./src/api.ts", "./src/browser/index.ts"], | ||
"exclude": ["src/nodejs/**/*.ts"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,8 @@ | ||
{ | ||
"$schema": "https://typedoc.org/schema.json", | ||
"name": "Marlowe ts-sdk", | ||
"entryPointStrategy": "packages", | ||
"out": "./docs", | ||
"readme": "none", | ||
"readme": "./packages/api.md", | ||
"includeVersion": true | ||
} |