Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
marmelroy committed Jul 23, 2017
1 parent ea1d7e4 commit d7d7d10
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ iOS Finder-style file browser in Swift with search, file previews and 3D touch.
:iphone: | Browse and select files and folders with a familiar UI on iOS.
:mag: | Pull down to search.
:eyeglasses: | Preview most file types. Including plist and json.
:pencil: | Edit/delete files.
:point_up_2: | 3D touch support for faster previews with Peek & Pop.
:white_flower: | Fully customizable.


## Usage

Import FileBrowser at the top of the Swift file.
Expand All @@ -43,6 +43,11 @@ You can open FileBrowser in a different root folder by initialising with an NSUR
let fileBrowser = FileBrowser(initialPath: customPath)
```

You can also allow editing/deleting files.
```swift
let fileBrowser = FileBrowser(initialPath: customPath, allowEditing: true)
```

Use the didSelectFile closure to change FileBrowser's behaviour when a file is selected.
```swift
fileBrowser.didSelectFile = { (file: FBFile) -> Void in
Expand All @@ -59,7 +64,7 @@ fileBrowser.excludesFilepaths = [secretFile]
### Setting up with [CocoaPods](http://cocoapods.org/?q=FileBrowser)
```ruby
source 'https://github.com/CocoaPods/Specs.git'
pod 'FileBrowser', '~> 0.2'
pod 'FileBrowser', '~> 0.3'
```

### Setting up with Carthage
Expand Down

0 comments on commit d7d7d10

Please sign in to comment.