Skip to content

Commit

Permalink
Add api.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hrajchert authored and bjornkihlberg committed Sep 14, 2023
1 parent dabce06 commit 01f3131
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 4 deletions.
23 changes: 23 additions & 0 deletions packages/api.md
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.
2 changes: 2 additions & 0 deletions packages/runtime/core/Readme.md
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.
4 changes: 1 addition & 3 deletions packages/wallet/typedoc.json
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"]
}
3 changes: 2 additions & 1 deletion typedoc.json
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
}

0 comments on commit 01f3131

Please sign in to comment.