Skip to content
This repository has been archived by the owner on Jun 27, 2020. It is now read-only.

Commit

Permalink
Updated README with list of valid completion-scopes
Browse files Browse the repository at this point in the history
  • Loading branch information
allewun committed May 4, 2015
1 parent 0472088 commit 269f9e7
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 269f9e7

Please sign in to comment.