From 83eb06439d394e353adf44c1b7c6b07d72436e2e Mon Sep 17 00:00:00 2001
From: tmhglnd <timohoogland@gmail.com>
Date: Mon, 23 Oct 2023 12:02:44 +0200
Subject: [PATCH] updated doc for beatRepeat

---
 docs/01-global.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/docs/01-global.md b/docs/01-global.md
index 96d227de..9acd7ca2 100644
--- a/docs/01-global.md
+++ b/docs/01-global.md
@@ -115,9 +115,11 @@ set volume 0.5 5000
 
 Set the global highPass filter cutoff in Hz for all instruments across the entire environment. Additional ramptime in milliseconds can be provided to create smooth transitions from one value to another.
 
+Alias: `hipass`
+
 **arguments**
 - {Float+} -> cutoff frequenzy in Hertz
-- {Int+} -> ramptime in milliseconds (optiona, default=0)
+- {Int+} -> ramptime in milliseconds (optional, default=0)
 
 ```java
 set highPass 900 5000
@@ -127,14 +129,29 @@ set highPass 900 5000
 
 Set the global low-pass filter cutoff in Hz for all instruments across the entire environment. Additional ramptime in milliseconds can be provided to create smooth transitions from one value to another.
 
+Alias: `lopass`
+
 **arguments**
 - {Float+} -> cutoff frequenzy in Hertz
-- {Int+} -> ramptime in milliseconds (optiona, default=0)
+- {Int+} -> ramptime in milliseconds (optional, default=0)
 
 ```java
 set lowPass 900 5000
 ```
 
+## beatRepeat
+
+A beatrepeating effect (sometimes called stutter) that continuously repeats a section of the entire sound that was last played. The repating interval is determined in divisions (`1/4`, `3/16`, etc). It immediately starts repeating at the moment of evaluating the code, so timing is key!
+
+Alias: `stutter`
+
+**arguments**
+- {Division} -> beatrepeat time interval in division
+
+```java
+set beatRepeat 1/4
+```
+
 ## osc
 
 Set the ip-address, in-port and out-port number for the network to transmit OSC-messages over using UDP. Default settings are 8000 (in-port), 9000 (out-port), localhost (127.0.0.1) (ip).