Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lekshmiraveendranath authored Feb 14, 2018
1 parent ca61712 commit 13dc15d
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ import LRSpotlight

class ViewController: UIViewController {

override func viewDidAppear(_ animated: Bool) {
super.viewDidAppear(animated)
startIntro()
}

func startIntro() {
let nodes = [SpotlightNode(text: "Show Spotlight on a Bar button item", target: .barButton(navigationItem.rightBarButtonItem)),
SpotlightNode(text: "Show Spotlight on a View", target: .view(nameLabel)),
Expand All @@ -36,6 +41,16 @@ pod 'LRSpotlight'
github "lekshmiraveendranath/Spotlight"
```

### Configurations
```swift
// Change the delay between spotlights (defaults to 3 seconds)
Spotlight.delay = 5.0
// Change the animation duration for spotlight appearance (Defaults to 0.25 seconds)
Spotlight.animationDuration = 0.1
// Display a background for the info text view (defaults to true)
Spotlight.showInfoBackground = true
```

## Features

- [x] Easy to integrate, just few lines of code
Expand Down

0 comments on commit 13dc15d

Please sign in to comment.