From 269f9e752714bc0acee91303e3b45572733cbe66 Mon Sep 17 00:00:00 2001 From: Allen Wu Date: Sun, 3 May 2015 19:39:28 -0700 Subject: [PATCH] Updated README with list of valid completion-scopes --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c0a6fd0..69fa099 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,46 @@ $ gem install xcodesnippet ## Usage +### Example + #### Sourcefile.swift ```swift --- title: "Hello, World!" summary: "Prints 'Hello World'" -completion-scope: Function or Method +completion-scopes: + - CodeBlock --- println("Hello, World!") ``` -#### Terminal Command +### Completion Scopes + +#### Objective-C + +* `ClassImplementation` +* `CodeExpression` +* `Preprocessor` +* `ClassInterfaceVariables` +* `All` +* `TopLevel` +* `ClassInterfaceMethods` +* `CodeBlock` +* `StringOrComment` + +#### Swift + +* `TopLevel` +* `ClassImplementation` +* `CodeBlock` +* `All` +* `CodeExpression` +* `StringOrComment` + + +### Terminal Command ``` $ xcodesnippet install path/to/source.m