create-miden-app 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,22 @@
1
+ # React + TypeScript + Vite + Miden
2
+
3
+ This template provides a minimal example on how to work with Miden using Vite.
4
+
5
+ This repository is based on the actual [create-vite NPM template](https://www.npmjs.com/package/create-vite).
6
+
7
+ ## Demo Client Interaction
8
+
9
+ The project includes a simple example of Miden client interactions in `src/miden/lib/demo.ts`. This demo file showcases a workflow for interacting with the Miden network, including:
10
+
11
+ - **Client Initialization**: Connecting to the Miden Testnet
12
+ - **Account Creation**: Creating new wallet accounts (Alice)
13
+ - **Faucet Setup**: Creating a fungible token faucet with custom tokens
14
+ - **Token Minting**: Minting tokens to an account via P2ID notes
15
+ - **Note Consumption**: Consuming notes to receive fungible assets
16
+ - **Token Transfers**: Sending tokens between accounts
17
+
18
+ The demo is a practical reference for building client-side applications that interact with the Miden rollup network, demonstrating the key primitives and transaction flows available through the Miden SDK.
19
+
20
+ ### Running the Demo
21
+
22
+ To explore the demo implementation, check out `src/miden/lib/demo.ts`. This file can serve as a starting point for building your own Miden-enabled applications.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "create-miden-app",
3
- "version": "1.0.0",
4
- "description": "A CLI to scaffold a new Miden project from a template",
3
+ "version": "1.0.1",
4
+ "description": "A Miden Project Scaffold Template",
5
5
  "bin": {
6
6
  "create-miden-app": "cli.js"
7
7
  },