diff --git a/README.md b/README.md index 60d2196..42967ca 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,11 @@ functions. The user can select which functions to trace. Functions can be selected individually or by namespace. The recorded data can be displayed, queried and profiled. +The whole loop in one take - trace some namespaces, run your code, then +explore the recorded call tree: + +![Tracing a namespace, running the code and exploring the recorded call tree](doc/images/sayid-workflow.gif) + Sayid currently has three components: * `sayid.core` and its supporting namespaces @@ -358,6 +363,8 @@ is traced and recorded right now. The keybindings are also listed by buffer below, and every list is available from within Emacs: press `h` in any Sayid buffer to pop up the matching help buffer. +![The Sayid menu popped up under a Clojure buffer, showing the commands grouped by workflow](doc/images/sayid-menu.png) + API docs for the core namespaces are available on [cljdoc](https://cljdoc.org/d/mx.cider/sayid/CURRENT). @@ -388,8 +395,13 @@ API docs for the core namespaces are available on The workspace opens in the `*sayid-tree*` buffer, a foldable tree built on -CIDER's `cider-tree-view`. Navigation and folding come from there; Sayid adds a -few actions on top: +CIDER's `cider-tree-view`. Every recorded call shows its arguments and its +return value (or the exception it threw): + +![The Sayid workspace tree showing recorded calls with arguments, return values and a thrown exception](doc/images/sayid-workspace-tree.png) + +Navigation and folding come from `cider-tree-view`; Sayid adds a few actions +on top: TAB -- fold or unfold the call at point RET, . -- jump to the call's source @@ -415,6 +427,8 @@ tree in the `*sayid-traced*` buffer. `RET` on a function jumps to its source; enable, disable and remove the trace at point, and `i`/`o` switch a function to an inner or outer trace. +![The traced-functions view, a namespaces to functions tree](doc/images/sayid-traced.png) + In the `*sayid-pprint*` buffer, press `h` to pop up the help buffer. diff --git a/doc/images/sayid-menu.png b/doc/images/sayid-menu.png new file mode 100644 index 0000000..da8a5a8 Binary files /dev/null and b/doc/images/sayid-menu.png differ diff --git a/doc/images/sayid-traced.png b/doc/images/sayid-traced.png new file mode 100644 index 0000000..f75510e Binary files /dev/null and b/doc/images/sayid-traced.png differ diff --git a/doc/images/sayid-workflow.gif b/doc/images/sayid-workflow.gif new file mode 100644 index 0000000..7787351 Binary files /dev/null and b/doc/images/sayid-workflow.gif differ diff --git a/doc/images/sayid-workspace-tree.png b/doc/images/sayid-workspace-tree.png new file mode 100644 index 0000000..b6115ec Binary files /dev/null and b/doc/images/sayid-workspace-tree.png differ