Update README.md

aenarete · Jul 28, 2024 · 08a96c2 · 08a96c2
1 parent edbf6a4
commit 08a96c2
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ### KiteViewers v0.4.15 - 2024-07-28
 #### Changed
+- add optional, boolean parameter `stop` to the function clear_viewer()
 - update KiteUtils to 0.7
 - add example show_messages.jl that receives html messages
 - fix the older examples

diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ viewer=Viewer3D(show_kite)
 
 ## Exported functions
 ```julia
-clear_viewer(kv::AKV)
+clear_viewer(kv::AKV; stop=true)
 update_system(kv::AKV, state::SysState; scale=1.0, kite_scale=3.5)
 save_png(kv::AKV; filename="video", index = 1)
 stop(kv::AKV)