@@ -15,34 +15,36 @@
# Overview
-The **Token Plan** Prototype is :
- - A Web DApp powered by **Marlowe Smart Contract** Technology Over **Cardano**.
- - A use case of a vesting contract developed and available in the [Marlowe ts-sdk](https://github.com/input-output-hk/marlowe-ts-sdk/),
- - A demonstration on how to build DApps Powered By Marlowe with well known mainstream web technologies such as **Typescript** & **React Framework**.
+The **Token Plan** Prototype includes the following:
+ - A Web DApp powered by **Marlowe Smart Contract** Technology Over **Cardano**
+ - A use case of a vesting contract developed and available in the [Marlowe ts-sdk](https://github.com/input-output-hk/marlowe-ts-sdk/)
+ - A demonstration of how to build DApps powered by Marlowe with well-known mainstream web technologies such as **Typescript** and **React Framework**.
-We have deployed instances for you to play with: [Test it by yourself](https://vesting-preprod.prod.scdev.aws.iohkdev.io/)!
+## Deployed Instance
+
+We invite you to test [a deployed instance of the Token Plan Prototype](https://vesting-preprod.prod.scdev.aws.iohkdev.io/) for yourself.
## The Vesting Contract
-The vesting contract has been designed in the
Marlowe Playground and then integrated in the [Marlowe ts-sdk](https://github.com/input-output-hk/marlowe-ts-sdk) to be used in that use case (Token Plans)...
-This contract is:
- - Available for use in the npm package `@marlowe.io/language-examples`
+We designed the vesting contract in the
Marlowe Playground and then integrated it in the [Marlowe TS-SDK](https://github.com/input-output-hk/marlowe-ts-sdk) to be used in the Token Plans use case.
+
+The vesting contract is available for use in the npm package `@marlowe.io/language-examples`
```ts
import { Vesting } from "@marlowe.io/language-examples";
```
- - Open source in the [`\marlowe-ts-sdk/blob/main/packages/language/examples/src/vesting.ts`](https://github.com/input-output-hk/marlowe-ts-sdk/blob/main/packages/language/examples/src/vesting.ts)
- - Documented in our ts-sdk [API Reference](https://input-output-hk.github.io/marlowe-ts-sdk/modules/_marlowe_io_language_examples.vesting.html)
+It is available as open source code here: [`\marlowe-ts-sdk/blob/main/packages/language/examples/src/vesting.ts`](https://github.com/input-output-hk/marlowe-ts-sdk/blob/main/packages/language/examples/src/vesting.ts)
+The vesting contract is documented in our TS-SDK [API Reference](https://input-output-hk.github.io/marlowe-ts-sdk/modules/_marlowe_io_language_examples.vesting.html).
## The Prototype
-It allows you to create ₳ Token Plans over Cardano:
-- ₳ Token Plans are created by a "Token Provider".
-- The Provider will deposit a given ₳ amount with a time-based scheme defining how to release these ₳ over time to a "Claimer".
+The prototype allows you to create ₳ Token Plans over Cardano.
+- ₳ Token Plans are created by a "Token Provider."
+- The Provider will deposit a given ₳ amount with a time-based scheme defining how to release these ₳ over time to a "Claimer."
-**N.B** : In the context of this prototype, we have combined these 2 participants' views to simplify the use case demonstration
+**N.B**: In the context of this prototype, we have combined these 2 participants' views to simplify the use case demonstration.
-The intent here is not to provide services to you over Cardano, but to demonstrate Marlowe technology capabilities with a concrete and fully open-source use case. We highly recommend that you look how this prototype is implemented.
+The intent here is not to provide services to you over Cardano, but to demonstrate Marlowe technology capabilities with a concrete and fully open-source use case. We highly recommend that you take a close look at how this prototype is implemented.
# Roadmap
The current version is a full end-to-end Marlowe contract example integrated within a Web DApp. It is a first iteration and is limited at the moment to three periods per Vesting Contract.
@@ -51,7 +53,7 @@ The second iteration will allow you to create an infinite number of periods. The
# How To Run Locally
-To get the dApp up and running on your local machine, follow these steps:
+To get the DApp up and running on your local machine, follow these steps:
1. **Clone the Repository**
```bash
@@ -64,15 +66,15 @@ To get the dApp up and running on your local machine, follow these steps:
4. **Configure Marlowe URLs in .env**
- To ensure the dApp communicates correctly with the Marlowe runtime and scan instances, you need to set the appropriate URLs in the `.env` file.
+ To ensure the DApp communicates correctly with the Marlowe Runtime and scan instances, you need to set the appropriate URLs in the `.env` file.
- ### Steps:
+ ### Steps
1. **Open the .env File**:
Navigate to the root directory of your project and open the `.env` file in your preferred text editor.
2. **Set the Marlowe Runtime Web URL**:
- Locate the line `MARLOWE_RUNTIME_WEB_URL=
`. Replace `` with the actual URL of your Marlowe runtime instance.
+ Locate the line `MARLOWE_RUNTIME_WEB_URL=`. Replace `` with the actual URL of your Marlowe Runtime instance.
MARLOWE_RUNTIME_WEB_URL=https://example-runtime-url.com
@@ -81,8 +83,8 @@ To get the dApp up and running on your local machine, follow these steps:
MARLOWE_SCAN_URL=https://example-scan-url.com
-3. **Run the dApp**
+3. **Run the DApp**
```bash
npm run start
-Enjoy and stay tuned for our next releases!
\ No newline at end of file
+Enjoy and stay tuned for our next releases!
