Skip to content

Commit 97b866e

Browse files
committed
Updated readme
1 parent 5ff7cba commit 97b866e

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
1-
#Notifications
1+
# Notifications
22

33
Sublime text plugin that uses terminal-notifier or subnotify for event notifications
44

5-
##Installation
6-
###Mac
7-
######Install terminal-notifier
5+
## Installation
6+
### Mac
7+
###### Install terminal-notifier
88

99
```bash
1010
gem install terminal-notifier
1111
```
1212

13-
######Install one of the following Sublime plugins
13+
###### Install one of the following Sublime plugins
1414
- Terminal Notifier
1515
- SubNotify
1616

17-
######Install this plugin
17+
### Windows
18+
1. Install the SubNotify plugin for Windows.
19+
2. Install either of the following
20+
- [Growl for Windows](http://growlforwindows.com)
21+
- Install Pywin32 (sublime plugin)
22+
23+
The Pywin32 plugin allows standard windows notifications via the task bar while growl for Windows allows growl style notifications.
24+
25+
### Install this plugin
1826
- Download repo directly into Packages folder
1927
- Install via Package Control
2028

21-
######Setup Preferences
29+
###### Setup Preferences
2230
Make sure Terminal Notifier or SubNotify are setup correctly.
2331

32+
33+
2434
Tell Notifications which plugin you want to use to display the notifications
2535

2636
```json
@@ -29,4 +39,11 @@ Tell Notifications which plugin you want to use to display the notifications
2939
}
3040
```
3141

32-
__Note:__ SubNotify is currently the default because it supports multiplatform notifications. This plugin has not yet been verified to work with Windows but the plan is to support Windows in the future.
42+
__Note:__ SubNotify is currently the default because it supports multiplatform notifications.
43+
44+
45+
46+
### To Do:
47+
- Enable custom message and title
48+
49+
Currently only post save notifications are setup. If you would like to see other notifications, please open a github issue and tag it as an enhancement.

0 commit comments

Comments
 (0)