diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bd37307 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Dane Williams + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 4a32a92..4dcc518 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,32 @@ > A dark theme for [tmux](https://github.com/tmux/tmux/wiki) +<<<<<<< HEAD ![Screenshot](./screenshot.jpg) +======= +## 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 + +## Screenshots +![Alt text](screenshots/tmux-dracula-screenshot.jpg?raw=true "Tmux Dracula") +tmux-dracula in action + + + +![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 +>>>>>>> 8e57456bdcd40f9b29d68b9f7848e84736782ff5 ## Install @@ -11,6 +36,7 @@ Use TPM (tmux plugin manager) and add to your .tmux.conf: 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 +<<<<<<< HEAD ## Features * Day, date, time, timezone @@ -34,4 +60,13 @@ This theme is maintained by the following person(s) and a bunch of awesome contr ## License -[MIT License](./LICENSE) \ No newline at end of file +[MIT License](./LICENSE) +======= +## 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` + +## License +This project is licensed under the MIT License - see [LICENSE.md](./LICENSE.md) for details +>>>>>>> 8e57456bdcd40f9b29d68b9f7848e84736782ff5