Skip to content

Commit

Permalink
Cite compatible Runtime version(s) in ts-sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
nhenin committed Jan 9, 2024
1 parent 1d38a60 commit e8357db
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,25 @@ The **Marlowe TS-SDK** is a suite of _TypeScript/JavaScript_ libraries for devel

It is composed of several npm packages documented in the [API reference](https://input-output-hk.github.io/marlowe-ts-sdk/) page.

## Prerequisites
## Runtime

The **Marlowe TS-SDK** provides a `@marlowe.io/runtime-rest-client` package and some asbtraction layers built on top of it (e.g : `@marlowe.io/runtime-lifecycle`).

In order to start working with these packages, you will need to have an URL to a running instance of the Marlowe Runtime :

| ts-sdk | runtime v0.0.5 | runtimev0.0.6 |
| ------- | :--------: | :------------: |
| [0.2.0-beta](https://github.com/input-output-hk/marlowe-ts-sdk/releases/tag/0.2.0-beta) || x | |

In order to start working with the Marlowe SDK you need to have a URL to a running instance of the Marlowe Runtime and one of the supported wallet extensions installed in your browser.

To get a running instance of the Runtime, it is recommended to check out the instructions on the [Marlowe Starter Kit](https://github.com/input-output-hk/marlowe-starter-kit)

## Wallet Extensions
## Wallets

The **Marlowe TS-SDK** extends capabilities on :
1. [CIP-30](https://github.com/cardano-foundation/CIPs/blob/master/CIP-0030/README.md) : An Interface providing access to Cardano Wallets via a Browser Extensions :

<p align="center">

| Wallets | Compatible | Not Compatible | Not Tested |
| ------- | :--------: | :------------: | :--------: |
Expand All @@ -36,6 +48,10 @@ To get a running instance of the Runtime, it is recommended to check out the ins
| Yoroi | | | ? |
| Typhon | | | ? |

</p>

2. [Lucid](https://github.com/spacebudz/lucid): In addition to the benefits provided by libraries, it allows you to develop Marlowe Contracts in a NodeJS environment.

## Examples & Contract Use Cases

Inside the [examples folder](./examples/Readme.md) you can find a set of minimal examples on how to use different packages of the SDK.
Expand Down

0 comments on commit e8357db

Please sign in to comment.