From 1cf6b37ee4e436fdcad5763cbc264d61b06120fe Mon Sep 17 00:00:00 2001
From: Felix Roos <roos@entrecode.de>
Date: Sun, 27 Mar 2022 22:41:37 +0200
Subject: [PATCH] add mini example

---
 packages/mini/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/packages/mini/README.md b/packages/mini/README.md
index b7516d06..5b1c364f 100644
--- a/packages/mini/README.md
+++ b/packages/mini/README.md
@@ -7,3 +7,31 @@ This package contains the mini notation parser and pattern generator.
 ```sh
 npm i @strudel.cycles/mini --save
 ```
+
+## Example
+
+```js
+import { mini } from '@strudel.cycles/mini';
+
+const pattern = mini('a [b c*2]');
+
+const events = pattern.firstCycle().map((e) => e.show());
+console.log(events);
+
+document.getElementById('app').innerHTML = events.join('<br/>');
+```
+
+yields:
+
+```log
+(0/1 -> 1/2, 0/1 -> 1/2, a)
+(1/2 -> 3/4, 1/2 -> 3/4, b)
+(3/4 -> 7/8, 3/4 -> 7/8, c)
+(7/8 -> 1/1, 7/8 -> 1/1, c)
+```
+
+[Play with @strudel.cycles/mini codesandbox](https://codesandbox.io/s/strudel-mini-example-oe9wcu?file=/src/index.js)
+
+## Mini Notation API
+
+See "Mini Notation" in the [Strudel Tutorial](https://strudel.tidalcycles.org/tutorial/)