diff --git a/README.md b/README.md index 11260b8..4a32a92 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,37 @@ -# tmux-dracula -Color scheme for tmux inspired by the popular dracula theme -For dracula theme on other platforms check out the official dracula theme +# Dracula for [tmux](https://github.com/tmux/tmux/wiki) + +> A dark theme for [tmux](https://github.com/tmux/tmux/wiki) -## Features -Day, date, time, timezone -Current location based on network with temperature and forecast icon (if available) -Network connection status and SSID -Battery percentage and AC power connection status -Color code based on if prefix is active or not -List of windows with current window highlighted +![Screenshot](./screenshot.jpg) -## Screenshots -![Alt text](screenshots/tmux-dracula-screenshot.jpg?raw=true "Tmux Dracula") -![Alt text](screenshots/alt-tmux-dracula-screenshot.jpg?raw=true "Tmux Dracula") -When prefix is enabled smiley face turns from green to yellow -When charging, 'AC' is displayed -If forecast information is available, a ☀, ☁, ☂, or ❄ unicode character corresponding with the forecast is displayed alongside the temperature - -## Compatibility -Designed for compatibility with Mac systems and tested on macOS 10.15 Catalina -Compatibility with Linux systems and/or WSL on Windows is not yet available - -## Installation +## Install + Use TPM (tmux plugin manager) and add to your .tmux.conf: `set -g @plugin 'danerwilliams/tmux-dracula'` Be sure that `run -b '~/.tmux/plugins/tpm/tpm'` is at the bottom of .tmux.config for tpm to work Restart tmux and then use `prefix + I` (capital I as in Install) to install -## Troubleshooting -Some users have experienced issues where the weather does not load. -This may be solved by manually running dracula.tmux: -`~/.tmux/plugins/tmux-dracula/dracula.tmux` +## Features + +* Day, date, time, timezone +* Current location based on network with temperature and forecast icon (if available) +* Network connection status and SSID +* Battery percentage and AC power connection status +* Color code based on if prefix is active or not +* List of windows with current window highlighted +* When prefix is enabled smiley face turns from green to yellow +* When charging, 'AC' is displayed +* If forecast information is available, a ☀, ☁, ☂, or ❄ unicode character corresponding with the forecast is displayed alongside the temperature + +## Compatibility + +Designed for compatibility with Mac systems and tested on macOS 10.15 Catalina +Compatibility with Linux systems and/or WSL on Windows is not yet available + +## Team + +This theme is maintained by the following person(s) and a bunch of awesome contributors + +## License + +[MIT License](./LICENSE) \ No newline at end of file diff --git a/screenshots/tmux-dracula-screenshot.jpg b/screenshot.jpg similarity index 100% rename from screenshots/tmux-dracula-screenshot.jpg rename to screenshot.jpg diff --git a/screenshots/alt-tmux-dracula-screenshot.jpg b/screenshots/alt-tmux-dracula-screenshot.jpg deleted file mode 100644 index 0db1a9c..0000000 Binary files a/screenshots/alt-tmux-dracula-screenshot.jpg and /dev/null differ