From 0ece1ea269a71eff60a19e94fcaeaa2cd0a4f547 Mon Sep 17 00:00:00 2001
From: Thomas Nowak <thomas@thomasnowak.net>
Date: Tue, 25 Jun 2024 22:50:45 +0200
Subject: [PATCH] Populated readme

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 25701db..621aef6 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
-# moxtab
\ No newline at end of file
+# muxtab
+
+[![pre-commit](https://github.com/nowathom/muxtab/actions/workflows/pre-commit.yaml/badge.svg)](https://github.com/nowathom/muxtab/actions/workflows/pre-commit.yaml/)
+
+Cronjobs for tmux.
+Hooks into the tmux status bar to periodically execute commands.
+
+Install as a tpm plugin:
+
+  set -g @plugin 'nowathom/muxtab'
+
+Then configure via a `muxtab` file in your tmux config directory. For example:
+
+```
+# runs vdirsyncer every 300 seconds
+300 vdirsyncer sync
+# touches a file every 100 seconds
+100 touch ~/hello
+```
+
+The default location for the `muxtab` file is `~/.muxtab`.
+This can be changed by setting the `@muxtab_file` tmux option:
+
+  set -g @muxtab_file '/path/to/muxtab'