summaryrefslogtreecommitdiff
path: root/plugins/emoji-clock
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/emoji-clock')
-rw-r--r--plugins/emoji-clock/README.md14
-rw-r--r--plugins/emoji-clock/emoji-clock.plugin.zsh2
2 files changed, 15 insertions, 1 deletions
diff --git a/plugins/emoji-clock/README.md b/plugins/emoji-clock/README.md
new file mode 100644
index 000000000..4934f380b
--- /dev/null
+++ b/plugins/emoji-clock/README.md
@@ -0,0 +1,14 @@
+# emoji-clock
+
+The plugin displays current time as an emoji symbol with half hour accuracy.
+
+To use it, add `emoji-clock` to the plugins array of your zshrc file:
+```
+plugins=(... emoji-clock)
+```
+
+## Features
+
+| Function | Description |
+|-------------------|----------------------------------------------------------------------|
+| `emoji-clock` | Displays current time in clock emoji symbol with half hour accuracy |
diff --git a/plugins/emoji-clock/emoji-clock.plugin.zsh b/plugins/emoji-clock/emoji-clock.plugin.zsh
index 0a55528f0..bdd606f89 100644
--- a/plugins/emoji-clock/emoji-clock.plugin.zsh
+++ b/plugins/emoji-clock/emoji-clock.plugin.zsh
@@ -2,7 +2,7 @@
# FILE: emoji-clock.plugin.zsh
# DESCRIPTION: The current time with half hour accuracy as an emoji symbol.
# Inspired by Andre Torrez' "Put A Burger In Your Shell"
-# http://notes.torrez.org/2013/04/put-a-burger-in-your-shell.html
+# https://notes.torrez.org/2013/04/put-a-burger-in-your-shell.html
# AUTHOR: Alexis Hildebrandt (afh[at]surryhill.net)
# VERSION: 1.0.0
# -----------------------------------------------------------------------------