Merge pull request #2 from yieldmo/installation-n-usage

Installation and usage

README.md

@@ -1,2 +1,22 @@
 # uncrustifier
 A simple Xcode 8 extension that wraps https://github.com/uncrustify/uncrustify/
+
+## build + installation
+1. Build using Xcode 8+.
+1. If you are using macOS 10.11, run ```sudo /usr/libexec/xpccachectl``` and restart your machine.
+1. Replace /Uncrustify/uncrustify.cfg with your desired configuration file.
+1. Open Uncrustifier.xcodeproj and run the Uncrustify target.  Choose Xcode as the host application.
+
+## usage
+
+Editor > Uncrustify > Format Current Document
+
+![](readme-images/demo.gif)
+
+The extension will format the active file.
+
+## contributing
+
+Feel free to send bugs or feature requests [here](https://github.com/yieldmo/uncrustifier/issues).
+
+[Pull requests](https://github.com/yieldmo/uncrustifier/pulls) are also welcome!

Uncrustify/SourceEditorCommand.swift

@@ -26,12 +26,15 @@ class SourceEditorCommand: NSObject, XCSourceEditorCommand {
         task.standardInput = invocation.buffer.completeBuffer
         task.standardOutput = outputPipe
         task.launchPath = commandPath
+
+        // configure uncrustify to format with bundled uncrustify.cfg, format for Objective-C, and strip messages
         task.arguments = [ "-c=\(commandConfigPath)","-l=OC","-q"]
 
         let inputPipe = Pipe()
         task.standardInput = inputPipe
         let stdinHandle = inputPipe.fileHandleForWriting
 
+        // write text to stdin (where uncrustify reads from)
         if let data = invocation.buffer.completeBuffer.data(using: .utf8) {
             stdinHandle.write(data)
             stdinHandle.closeFile()
@@ -51,6 +54,7 @@ class SourceEditorCommand: NSObject, XCSourceEditorCommand {
 
         }
 
+        // fixes crash if there is no selection when completion handler is called
         invocation.buffer.selections.add(XCSourceTextRange(start: XCSourceTextPosition(line: 0, column: 0), end: XCSourceTextPosition(line: 0, column: 0)))
 
         completionHandler(nil)