@@ -32,57 +32,74 @@
## What is this
-tmux2k is a `` that allows `` to do ``.
+tmux2k is a `tmux` plugin for that adds `powerline` support and pretty colors to your `tmux` status bar.
## Inspiration
-tmux2k was inspired by ``.
+tmux2k was inspired by [dracula/tmux](https://github.com/dracula/tmux).
## Prerequisites
Before you begin, ensure you have met the following requirements:
-- You have installed the latest version of ``
+- You have installed the latest version of `tmux`.
+- [tpm](https://github.com/tmux-plugins/tpm) for managing `tmux` plugins.
+- A [patched nerd font](https://www.nerdfonts.com/) for `powerline` and glyphs support.
-## Getting tmux2k
+## Installing tmux2k
-To get tmux2k, follow these steps:
+Using `tpm`
+
+If you are a `tpm` user, you can install the theme and keep up to date by adding the following to your `.tmux.conf` file:
```bash
-git clone https://github.com/2kabhishek/tmux2k
-cd tmux2k
-
+set -g @plugin 'dracula/tmux'
+
```
-## Using tmux2k
+Add any configuration options below this line in your tmux config.
+
+### Activating tmux2k
+
+- Make sure run -b `~/.tmux/plugins/tpm/tpm` is at the bottom of your `.tmux.conf`
+- Run `tmux`
+- Use the `tpm` install command: prefix + I (default prefix is `ctrl+b`)
+
+## Configuring tmux2k
```bash
-USAGE:
- command [FLAGS] [OPTIONS]
+# Tmux 2K default configs
+# available plugins: battery, cpu-usage, git, gpu-usage, ram-usage, network, network-bandwidth, network-ping, weather, time
+set -g @tmux2k-left-plugins "git cpu-usage ram-usage"
+set -g @tmux2k-right-plugins "battery network time"
+set -g @tmux2k-show-powerline true
+set -g @tmux2k-show-fahrenheit false
+set -g @tmux2k-military-time true
+set -g @tmux2k-border-contrast true
-FLAGS:
- -h, --help Prints help information.
+# available colors: white, gray, dark_gray, light_purple, dark_purple, cyan, green, orange, red, pink, yellow
+set -g @tmux2k-[plugin-name]-colors "[background] [foreground]"
+set -g @tmux2k-cpu-usage-colors "blue dark_gray"
-OPTIONS:
- -o, --option Option description.
- Options are: a, b. [default: a]
-
-Example:
+# it can accept `session`, `rocket`, `window`, or any character.
+set -g @tmux2k-show-left-icon ""
+# update powerline symbols
+set -g @dracula-show-left-sep ""
+set -g @dracula-show-right-sep ""
+# change refresh rate
+set -g @dracula-refresh-rate 5
```
## How it was built
-tmux2k was built using ``
-
-## Challenges faced
-
-While building tmux2k the main challenges were ``
+tmux2k was built using `neovim`, `shellcheck`, `shellcheck`.
## What I learned
-While building tmux2k I `` about ``
+- Learned a lot about the `tmux` and `tpm` ecosystem.
+- Did some fancy shell scripting.
## What's next
@@ -90,12 +107,7 @@ Planning to add ``.
### To-Do
-- [x] Setup repo
-- [ ] Think real hard
-- [ ] Start typing
-- [ ] Change me
-- [ ] Update README
-- [ ] Finish it
+- [ ] Fix left plugins color logic
Hit the ⭐ button if you found this useful.