aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2023-02-24 15:26:22 -0800
committerKaz Kylheku <kaz@kylheku.com>2023-02-24 15:26:22 -0800
commit46bc4823785cf9b19661ec347c9530c7bbfb8eaf (patch)
treee44864fa737feb1f4e7e6c374bacefe2bd0847d6
parent750414a11255d23771f833d12b487d753fcdd346 (diff)
downloadpw-46bc4823785cf9b19661ec347c9530c7bbfb8eaf.tar.gz
pw-46bc4823785cf9b19661ec347c9530c7bbfb8eaf.tar.bz2
pw-46bc4823785cf9b19661ec347c9530c7bbfb8eaf.zip
README: longer description; change videos.
Let's use the voiced /proc/interrupts video as the main demo.
-rw-r--r--README.md20
1 files changed, 14 insertions, 6 deletions
diff --git a/README.md b/README.md
index 92f0e51..d55f8b0 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
## What is `pw`?
-`pw` stands for Pipe Watch. Pipe-Watch is a new monitoring utility for
-Unix-like systems, developed starting in April 2022.
+`pw` stands for Pipe Watch. Pipe Watch is a new, unique text stream monitoring
+utility for Unix-like systems, developed starting in April 2022.
+Pipe Watch is used similarly to a pager, like the `less` utility, but the
+paradigm is quite different.
## Demo Video
-<div style="padding:55% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/705257869?h=7e8d85a3c2&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen style="position:absolute;top:0;left:0;width:100%;height:100%;" title="pipewatch-gnome-strace.mp4"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
+<div style="padding:55% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/710155314?h=25a55d09c0&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen style="position:absolute;top:0;left:0;width:100%;height:100%;" title="pipe-watch-proc-interrupts.mp4"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
## More Info
@@ -68,15 +70,21 @@ for text streams.
The [`pw` man page](../tree/pw.1) has all the usage details.
-## LIcense
+## License
`pw` is offered under the two-clause BSD license. See the
[`LICENSE`](../tree/LICENSE) file.
-## Video: Vertical Panes Demo
+## Other Videos
+
+Original Demo:
+
+<div style="padding:75% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/705257869?h=7e8d85a3c2&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen style="position:absolute;top:0;left:0;width:100%;height:100%;" title="pipewatch-gnome-strace.mp4"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
+
+Vertical Panes Demo
<div style="padding:75% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/707385984?h=839efed1ad&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen style="position:absolute;top:0;left:0;width:100%;height:100%;" title="pw-split-screen.mp4"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
## High Level State Diagram
-![PipeWatch State Diagram](https://www.plantuml.com/plantuml/png/ZLHFRzi-3BthKn0v_D3-bWOz3Xam55qNeCEm0kjssRe3Qp6nK5ioI3bPjlMxJx8Znuupf0S34lduXu_FkXAFxEkoK99XGV3wyX8sHljSgU___u2BYxTmZTdJYbrjDSnXahcon73y0zK6_fjqg8LZEewQADLpHkm7ztXVIqLMKqI_yrnSV5DgO1vNVbo5J3tJkEeo8aPPJc7cO9q7hgqrTgNK07xlqTS2ahkDVGFQI5NW5kfAeoU1sXOamPjIpPII443zahyLmB2Vhp4wb0hftrjFh61lYlv-P_SLPXHuOALWwF1eDR86OwlQ0nE6waF8RUEfK2HSVSwkNkMmk5tS7G8_qGR4OXMczDAGuV69R2pPZjEr5uT9nXiZ6R8EvfvnOOeYMg8fNU9GFJJCcoOQhpnOxpfQnVoYMHEQu2awPPeFi0_Ms8m9XKAUirUm4zqq92KkWIc2pXN0e9jstd0awRAPiYHjq5EnFS0ohP1risQt1CzcjI8EPmPlIdArb-b1H9GzCW7goAvtaDNCP7r7yNZ4ETmLUjVIabtP4gJPLHNfCHW5R3S2CfjrecsucRIms1uJVQwjJOH-QGU9wqz3dSav27crY-WG4J-8xo84ie8mG5BC47Mp8vTfoIGvwKXDOY5fx5YWi_14sqSNvOsPDslZjzD6uedqwV4uXiA5audxNsC1zBCol9sDHZheBISvqjeuQ9EJfJLnkvxCMK_M2vJeipnnCcl2dbNydfKQl60VZQMkI5knVLuwKTTLnIJIUqbw2U8kTyRUXb5WihzEzfYeo0Hepj6he7EqB-pB_qk05DpzHKKa49DoKVzRxjSlLtl4dXRxQIPssa-u99M4xDqd0-1U-17MtHhkO9WeliC3pO2p0vsca9VBjD_0A7iIu1XuGf5HYrTaTLqMVm40.png)
+![Pipe Watch State Diagram](https://www.plantuml.com/plantuml/png/ZLHFRzi-3BthKn0v_D3-bWOz3Xam55qNeCEm0kjssRe3Qp6nK5ioI3bPjlMxJx8Znuupf0S34lduXu_FkXAFxEkoK99XGV3wyX8sHljSgU___u2BYxTmZTdJYbrjDSnXahcon73y0zK6_fjqg8LZEewQADLpHkm7ztXVIqLMKqI_yrnSV5DgO1vNVbo5J3tJkEeo8aPPJc7cO9q7hgqrTgNK07xlqTS2ahkDVGFQI5NW5kfAeoU1sXOamPjIpPII443zahyLmB2Vhp4wb0hftrjFh61lYlv-P_SLPXHuOALWwF1eDR86OwlQ0nE6waF8RUEfK2HSVSwkNkMmk5tS7G8_qGR4OXMczDAGuV69R2pPZjEr5uT9nXiZ6R8EvfvnOOeYMg8fNU9GFJJCcoOQhpnOxpfQnVoYMHEQu2awPPeFi0_Ms8m9XKAUirUm4zqq92KkWIc2pXN0e9jstd0awRAPiYHjq5EnFS0ohP1risQt1CzcjI8EPmPlIdArb-b1H9GzCW7goAvtaDNCP7r7yNZ4ETmLUjVIabtP4gJPLHNfCHW5R3S2CfjrecsucRIms1uJVQwjJOH-QGU9wqz3dSav27crY-WG4J-8xo84ie8mG5BC47Mp8vTfoIGvwKXDOY5fx5YWi_14sqSNvOsPDslZjzD6uedqwV4uXiA5audxNsC1zBCol9sDHZheBISvqjeuQ9EJfJLnkvxCMK_M2vJeipnnCcl2dbNydfKQl60VZQMkI5knVLuwKTTLnIJIUqbw2U8kTyRUXb5WihzEzfYeo0Hepj6he7EqB-pB_qk05DpzHKKa49DoKVzRxjSlLtl4dXRxQIPssa-u99M4xDqd0-1U-17MtHhkO9WeliC3pO2p0vsca9VBjD_0A7iIu1XuGf5HYrTaTLqMVm40.png)