Standardize README

This commit is contained in:
Zeno Rocha 2020-04-07 17:08:54 -07:00
parent 3089559638
commit 4bdbc7fa64

View file

@ -1,36 +1,37 @@
# Dracula for [tmux](https://github.com/tmux/tmux/wiki) # Dracula for [tmux](https://github.com/tmux/tmux/wiki)
> A dark theme for [tmux](https://github.com/tmux/tmux/wiki) > A dark theme for [tmux](https://github.com/tmux/tmux/wiki)
![Screenshot](./screenshot.png) ![Screenshot](./screenshot.png)
## Install ## Install
Use TPM (tmux plugin manager) and add to your .tmux.conf: All instructions can be found at [draculatheme.com/tmux](https://draculatheme.com/tmux).
`set -g @plugin 'dracula/tmux'`
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
## Features ## Features
* Day, date, time, timezone * Day, date, time, timezone
* Current location based on network with temperature and forecast icon (if available) * Current location based on network with temperature and forecast icon (if available)
* Network connection status and SSID * Network connection status and SSID
* Battery percentage and AC power connection status * Battery percentage and AC power connection status
* Color code based on if prefix is active or not * Color code based on if prefix is active or not
* List of windows with current window highlighted * List of windows with current window highlighted
* When prefix is enabled smiley face turns from green to yellow * When prefix is enabled smiley face turns from green to yellow
* When charging, 'AC' is displayed * When charging, 'AC' is displayed
* If forecast information is available, a ☀, ☁, ☂, or ❄ unicode character corresponding with the forecast is displayed alongside the temperature * If forecast information is available, a ☀, ☁, ☂, or ❄ unicode character corresponding with the forecast is displayed alongside the temperature
## Compatibility ## Compatibility
Designed for compatibility with Mac systems and tested on macOS 10.15 Catalina 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 Compatibility with Linux systems and/or WSL on Windows is not yet available
## Team ## Team
This theme is maintained by the following person(s) and a bunch of awesome contributors This theme is maintained by the following person(s) and a bunch of [awesome contributors](https://github.com/dracula/tmux/graphs/contributors).
[![Dane Williams](https://avatars3.githubusercontent.com/u/22798229?v=4&s=70)](https://github.com/danerwilliams) |
--- |
[Dane Williams](https://github.com/danerwilliams) |
## License ## License