summaryrefslogtreecommitdiff
path: root/plugins/emoji-clock
diff options
context:
space:
mode:
authorSagar Patil <sagar010797@gmail.com>2018-10-04 02:36:02 +0530
committerMarc Cornellà <marc.cornella@live.com>2018-10-03 23:06:02 +0200
commit9d57a90b41b1d8c3d80de8a8b0ac23154231388c (patch)
tree4284bf938dcbf41a4acd135d0ac51be291949942 /plugins/emoji-clock
parent2d967d66e618ad6d95978ba5ede33fa5f24fe489 (diff)
downloadzsh-9d57a90b41b1d8c3d80de8a8b0ac23154231388c.tar.gz
zsh-9d57a90b41b1d8c3d80de8a8b0ac23154231388c.tar.bz2
zsh-9d57a90b41b1d8c3d80de8a8b0ac23154231388c.zip
emoji-clock: add README (#7208)
Diffstat (limited to 'plugins/emoji-clock')
-rw-r--r--plugins/emoji-clock/README.md14
1 files changed, 14 insertions, 0 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 |