Suggestion for main readme

[jplgarcia]

Here is a suggestion for structuring the main readme.md file. From what I gathered at events the largest number of questions raise from how to do the following:

deroll

Minimal example

Deroll is a TypeScript framework for developing Cartesi applications. The code below is a minimal application which just loops forever fetching inputs, but with no input handlers. In that case any input is rejected.

import { createApp } from "@deroll/app";

const app = createApp({ url: "http://127.0.0.1:5004" });
// TODO: add input handlers here
app.start().catch((e) => process.exit(1));

Frequently used

• Routing
• Handling Data
• Outputs
• Wallets

Routing

Explain the routing system.

Examples

1. Basic Routing Example

   // Example code for basic routing

2. Dynamic Routing Example

   // Example code for dynamic routing

Handling Data

Examples

1. Data Decoding Example

   // Example code for data decoding

2. Data Encoding Example

   // Example code for data encoding

Outputs

Examples

1. Vouchers Example

   // Example code for generating vouchers

2. Notices Example

   // Example code for generating notices

3. Reports Example

   // Example code for generating reports

Wallets

Examples

1. Deposit Function Example

   // Example code for deposit function

2. Transfer Function Example

   // Example code for transfer function

3. Withdraw Function Example

   // Example code for withdraw function

[tuler]

Great. I’m planning to less the term “routing” and use “handling” instead. This will align better with the design of deroll.