docs: add gif

vitonsky · Aug 4, 2024 · 02d70ce · 02d70ce
1 parent 16257f6
commit 02d70ce
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,8 @@ Ideal to draw progress in CLI, web and mobile.
 - Zero dependencies. Works everywhere - node, browsers, toaster, etc.
 - ETA, speed measurements and average step time estimation
 
+![](./docs/eta.gif)
+
 # Usage
 
 Install with `npm i arrival-time` or `yarn add arrival-time`
@@ -82,3 +84,8 @@ Return `estimate` value
 ### reset(time?: number)
 
 Reset start time to current time
+
+# Related projects
+
+- [humanize-duration](https://www.npmjs.com/package/humanize-duration) - converts time in ms to human readable time
+- [log-update](https://www.npmjs.com/package/log-update) - print and redraw messages to stdout
diff --git a/docs/eta.gif b/docs/eta.gif