Skip to content

Commit c4fed45

Browse files
committed
update readme
2 parents c8fe244 + 8e57456 commit c4fed45

File tree

2 files changed

+57
-1
lines changed

2 files changed

+57
-1
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Dane Williams
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,32 @@
22

33
> A dark theme for [tmux](https://github.com/tmux/tmux/wiki)
44
5+
<<<<<<< HEAD
56
![Screenshot](./screenshot.jpg)
7+
=======
8+
## Features
9+
Day, date, time, timezone
10+
Current location based on network with temperature and forecast icon (if available)
11+
Network connection status and SSID
12+
Battery percentage and AC power connection status
13+
Color code based on if prefix is active or not
14+
List of windows with current window highlighted
15+
16+
## Screenshots
17+
![Alt text](screenshots/tmux-dracula-screenshot.jpg?raw=true "Tmux Dracula")
18+
tmux-dracula in action
19+
20+
21+
22+
![Alt text](screenshots/alt-tmux-dracula-screenshot.jpg?raw=true "Tmux Dracula")
23+
When prefix is enabled smiley face turns from green to yellow
24+
When charging, 'AC' is displayed
25+
If forecast information is available, a ☀, ☁, ☂, or ❄ unicode character corresponding with the forecast is displayed alongside the temperature
26+
27+
## Compatibility
28+
Designed for compatibility with Mac systems and tested on macOS 10.15 Catalina
29+
Compatibility with Linux systems and/or WSL on Windows is not yet available
30+
>>>>>>> 8e57456bdcd40f9b29d68b9f7848e84736782ff5
631
732
## Install
833

@@ -11,6 +36,7 @@ Use TPM (tmux plugin manager) and add to your .tmux.conf:
1136
Be sure that `run -b '~/.tmux/plugins/tpm/tpm'` is at the bottom of .tmux.config for tpm to work
1237
Restart tmux and then use `prefix + I` (capital I as in Install) to install
1338

39+
<<<<<<< HEAD
1440
## Features
1541

1642
* Day, date, time, timezone
@@ -34,4 +60,13 @@ This theme is maintained by the following person(s) and a bunch of awesome contr
3460

3561
## License
3662

37-
[MIT License](./LICENSE)
63+
[MIT License](./LICENSE)
64+
=======
65+
## Troubleshooting
66+
Some users have experienced issues where the weather does not load.
67+
This may be solved by manually running dracula.tmux:
68+
`~/.tmux/plugins/tmux-dracula/dracula.tmux`
69+
70+
## License
71+
This project is licensed under the MIT License - see [LICENSE.md](./LICENSE.md) for details
72+
>>>>>>> 8e57456bdcd40f9b29d68b9f7848e84736782ff5

0 commit comments

Comments
 (0)