Update README.md

README.md

@@ -1,6 +1,27 @@
-This package adds basic svn command shortcuts to Sublime Text v2:
+Sublime Text Subversion plug-in
+===============================
 
- * status
- * update
- * add
- * commit (with diff view and commit message dialog)
+A very basic Subversion client for the [Sublime Text](http://www.sublimetext.com/) text editor.
+
+The aim is to provide a quick method to commit simple changes without leaving Sublime.  To this end the only subversion commands that are supported are:
+
+* 'status', to check what will be commited
+* 'update', to get the latest version of a file
+* 'add', to add new files to the commit
+* 'commit', to commit changes
+
+Committing will show you a diff of your changes, and allow you to enter a single line of text for the commit message.
+
+
+Usage
+-----
+
+ * Copy both files into your 'Sublime Text/Packages/User' folder which you should be able to find in your profile folder.
+ * Make sure that you have the subversion command line client installed and that it's in your path.
+ * All commands are accessed via keyboard shortcuts, which you can view/change by opening Default.sublime-keymap.
+
+
+Known Issues
+------------
+
+Very occasionally Sublime will freeze when generating the diff.  Killing the svn.exe will bring Sublime back to life.