Skip to content

Commit f408deb

Browse files
committed
Update QuickStart
1 parent 1636038 commit f408deb

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,38 @@ Alternatively, you can simply copy the [source code](src/index.ts) directly into
4141

4242
## Quick Start
4343

44-
```typescript
45-
// Basic example coming soon
44+
Run the following command to create a new PocketFlow project:
45+
46+
```bash
47+
npx create-pocketflow
48+
```
49+
50+
Use cursor/windsurf/any other LLM builtin IDE to open the project.
51+
You can type the following prompt to the agent to confirm the project is setup correctly:
52+
53+
```
54+
Help me describe briefly about PocketFlow.js
55+
```
56+
57+
Simply start typing your prompt, and the AI agent will build the project for you.
58+
Here's a simple example:
59+
60+
```
61+
I want to create an application that can write novel:
62+
63+
1. User can enter a novel title
64+
2. It will generate a outline of the novel
65+
3. It will generate a chapter based on the outline
66+
4. It will save the chapter to ./output/title_name.md
67+
68+
First, read the requirements carefully.
69+
Then, start with design.md first. Stop there until further instructions.
70+
```
71+
72+
Once you have the design, and you have no questions, start the implementation by simply typing:
73+
74+
```
75+
Start implementing the design.
4676
```
4777

4878
## Documentation

0 commit comments

Comments
 (0)