@mudlab/create-workflow 1.0.1 → 1.0.2

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mudlab/create-workflow",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Create Mudlab workflow projects with a single command",
5
5
  "bin": {
6
6
  "create-mudlab-workflow": "./bin/create.js"
@@ -1,4 +1,6 @@
1
- # Mudlab API Configuration
1
+ # ===========================================
2
+ # MUDLAB API (Required for pushing workflows)
3
+ # ===========================================
2
4
  # Get your API key:
3
5
  # 1. Log into https://mudlab.io
4
6
  # 2. Click "API Keys" in the left sidebar
@@ -6,8 +8,17 @@
6
8
  MUDLAB_API_URL=https://mudlab.io
7
9
  MUDLAB_API_KEY=your_mudlab_api_key_here
8
10
 
9
- # Add your integration API keys below
10
- # These are passed to tools when running workflows locally
11
+ # ===========================================
12
+ # INTEGRATION KEYS (For local testing only)
13
+ # ===========================================
14
+ # These keys are used when running tools locally with Node.js.
15
+ #
16
+ # FOR PRODUCTION: Add these in Mudlab UI instead:
17
+ # 1. Log into https://mudlab.io
18
+ # 2. Click "Environment Variables" in the left sidebar (below API Keys)
19
+ # 3. Add your variables there
20
+ #
21
+ # The variable NAMES you define here should match what you add in Mudlab.
11
22
  # Example:
12
23
  # NOTION_API_KEY=your_notion_api_key
13
24
  # NOTION_DATABASE_ID=your_database_id
@@ -21,7 +21,25 @@ Automated workflows powered by [Mudlab](https://mudlab.io).
21
21
  MUDLAB_API_KEY=ml_your_key_here
22
22
  ```
23
23
 
24
- 4. Add any other integration keys you need (Notion, Resend, Stripe, etc.)
24
+ 4. (Optional) Add integration keys for **local testing**:
25
+ ```
26
+ NOTION_API_KEY=your_notion_api_key
27
+ RESEND_API_KEY=your_resend_api_key
28
+ ```
29
+
30
+ ## Environment Variables
31
+
32
+ Your workflows reference environment variable **names** (like `NOTION_API_KEY`). The actual values are stored in two places:
33
+
34
+ | Environment | Where to add keys | Used for |
35
+ |-------------|-------------------|----------|
36
+ | **Local** | `.env` file | Testing tools with `node` |
37
+ | **Production** | Mudlab UI | Running workflows via webhooks |
38
+
39
+ **To add production keys in Mudlab:**
40
+ 1. Log into [Mudlab](https://mudlab.io)
41
+ 2. Click **Environment Variables** in the left sidebar (below API Keys)
42
+ 3. Add your variables (use the same names as in your workflow definitions)
25
43
 
26
44
  ## Creating Workflows
27
45