Skip to content
This repository was archived by the owner on Jan 31, 2024. It is now read-only.

Commit 9362fcf

Browse files
authored
Update README.md
1 parent de8d50b commit 9362fcf

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ pnpm run dev # Access dev server at http://localhost:3000
2121
```
2222

2323
---
24+
## How does this work?
2425
FlowchartGPT utilises a **chain** to generate the nodes and edges required to render a flowchart for the given prompt. More specifically, it chains several calls to `gpt-3.5-turbo` together. Using a chain helps GPT-3.5 understand the requirements for generating the flowchart and ensures the validity of the output. This achieves consistent and high-quality results in comparison with compressing instructions into a single prompt, which yielded inconsistent or poor results in testing.
2526

2627
The steps in the chain are illustrated below.
@@ -29,6 +30,9 @@ The steps in the chain are illustrated below.
2930
<img src="https://user-images.githubusercontent.com/33971845/235194794-a9b9bbe9-aa8e-45ca-90d0-995623b57a19.png" width="600" />
3031
</div>
3132

33+
## What prompts do you use?
34+
Great question! You can find the prompts [here](https://github.com/RelevanceAI/flowchartgpt/blob/main/PROMPTS.md).
35+
3236
## License
3337

34-
Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).
38+
Licensed under the [MIT license]([https://github.com/shadcn/ui/blob/main/LICENSE.md](https://github.com/RelevanceAI/flowchartgpt/blob/main/LICENSE)).

0 commit comments

Comments
 (0)