Skip to content

Commit c1397c5

Browse files
committed
Update README
1 parent 09417ec commit c1397c5

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,22 @@ Optional integrations for different cloud providers can be installed using `plug
6565

6666
Support for parallelisation can be installed using `plugboard[ray]`.
6767

68+
## ⚡ Quickstart with AI
69+
70+
The fastest way to get started is to let your AI coding assistant build your first model. Run the following command in your project directory:
71+
72+
```shell
73+
plugboard ai init
74+
```
75+
76+
This copies a context file (`AGENTS.md`) into your project that gives your AI tool everything it needs to know about Plugboard: how components work, how to wire them together, library components that are already available, and best practices for building models.
77+
78+
Once initialised, simply open your AI tool of choice (GitHub Copilot, Cursor, Claude, etc.) and describe the model you want to build. For example:
79+
80+
> *"I want to simulate a production line with three machines in series. Each machine has a processing time drawn from a normal distribution and a 5% chance of failure. Model the throughput over 1000 time steps and save the results to a CSV."*
81+
82+
Your AI assistant will use the `AGENTS.md` context to generate working Plugboard code — components, connectors, and a runnable process — tailored to your description.
83+
6884
## 🚀 Usage
6985

7086
<a href="https://colab.research.google.com/github/plugboard-dev/plugboard/blob/main/"><img src="https://colab.research.google.com/assets/colab-badge.svg"></a>

0 commit comments

Comments
 (0)