Update readme. Add files to repo

Author: thomscode

Main.sublime-menu

@@ -0,0 +1,39 @@
+[
+    {
+        "caption": "Preferences",
+        "mnemonic": "n",
+        "id": "preferences",
+        "children":
+        [
+            {
+                "caption": "Package Settings",
+                "mnemonic": "P",
+                "id": "package-settings",
+                "children":
+                [
+                    {
+                        "caption": "Notifications",
+                        "children":
+                        [
+                            {
+                                "command": "open_file",
+                                "args": {"file": "${packages}/Notifications/notifications.sublime-settings"},
+                                "caption": "Settings – Default"
+                            },
+                            {
+                                "command": "open_file",
+                                "args": {"file": "${packages}/User/notifications.sublime-settings"},
+                                "caption": "Settings – User"
+                            },
+                            {"caption": "-"},
+                            {
+                                "command": "notifications_test",
+                                "caption": "Test Notifications"
+                            }
+                        ]
+                    }
+                ]
+            }
+        ]
+    }
+]

Notifications.py

@@ -0,0 +1,37 @@
+import os
+import subprocess
+import sublime
+import sublime_plugin
+
+PLUGIN_SETTINGS = "notifications.sublime-settings"
+
+
+class Notifiers(sublime_plugin.EventListener):
+	""" Notify user on file save """
+	def growl(self, msg, title):
+		settings = sublime.load_settings(PLUGIN_SETTINGS)
+		notifier = settings.get('notifier')
+
+		if notifier == 'subnotify':
+			# SubNotify
+			sublime.active_window().run_command('sub_notify', {
+				'title': title,
+				'msg': msg,
+				'sound': False
+			})
+
+		elif notifier == 'terminal-notifier':
+			# Terminal Notifier
+			sublime.active_window().run_command('terminal_notifier', {
+				'title': title,
+				# 'subtitle': title,
+				'message': msg
+			})
+
+	def on_post_save(self, view):
+		filename = os.path.basename(view.file_name())
+		title = 'File was saved.'
+		self.growl(filename, title)
+
+
+print(os.getcwd())

README.md

@@ -1,4 +1,32 @@
-notifications
-=============
+#Notifications
 
 Sublime text plugin that uses terminal-notifier or subnotify for event notifications
+
+##Installation
+###Mac
+######Install terminal-notifier
+
+```bash
+gem install terminal-notifier
+```
+
+######Install one of the following Sublime plugins
+- Terminal Notifier
+- SubNotify
+
+######Install this plugin
+- Download repo directly into Packages folder
+- Install via Package Control
+
+######Setup Preferences
+Make sure Terminal Notifier or SubNotify are setup correctly.
+
+Tell Notifications which plugin you want to use to display the notifications
+
+```json
+{
+	"notifier": "subnotify"
+}
+```
+
+__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.

notifications.sublime-settings

@@ -0,0 +1,5 @@
+{
+	// Notification System to use.
+	// Possible values: terminal-notifier, subnotify
+	"notifier": "subnotify"
+}