Skip to content

Commit dcac955

Browse files
committed
docs(playground): improve Node.js ESM example README formatting
- Added line breaks in README.md for better readability - Removed trailing whitespace in package.json - Enhanced code block and section formatting in README
1 parent 2953cb5 commit dcac955

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

playground/nodejs-esm/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,21 @@ nodejs-esm/
2727
## Getting Started
2828

2929
1. Install dependencies:
30+
3031
```bash
3132
npm install
3233
```
3334

3435
2. Configure your environment:
36+
3537
- Copy `.env.example` to `.env` (if not already done)
3638
- Add your OpenAI API key to `.env`:
3739
```
3840
OPENAI_API_KEY=your-api-key-here
3941
```
4042
4143
3. Run the examples:
44+
4245
```bash
4346
# Run ESM version
4447
npm start
@@ -50,11 +53,13 @@ nodejs-esm/
5053
## Code Examples
5154

5255
### ESM Version (index.js)
56+
5357
```javascript
5458
import { Agent, Task, Team } from 'kaibanjs';
5559
```
5660

5761
### CommonJS Version (index.cjs)
62+
5863
```javascript
5964
const { Agent, Task, Team } = require('kaibanjs');
6065
```
@@ -63,4 +68,4 @@ const { Agent, Task, Team } = require('kaibanjs');
6368

6469
- This example demonstrates that KaibanJS works in Node.js environments without requiring React as a dependency
6570
- The example uses zustand's core functionality without React-specific features
66-
- Both ESM and CommonJS versions implement the same functionality to showcase module system compatibility
71+
- Both ESM and CommonJS versions implement the same functionality to showcase module system compatibility

playground/nodejs-esm/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@
1414
"kaibanjs": "^0.14.0",
1515
"dotenv": "^16.4.5"
1616
}
17-
}
17+
}

0 commit comments

Comments
 (0)