Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
npu3pak committed Jul 29, 2019
1 parent 89d8276 commit 6f0230b
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ it, simply add the following line to your Podfile:
pod 'Overlays'
```

## Usage
## Example

To run the example project, clone the repo, and run `pod install` from the Example directory first.

### Prepare overlay view

Expand All @@ -37,9 +39,7 @@ class CustomOverlay: UIView, OverlayView {
}
```

### Inside a View Controller

![Example image](https://raw.githubusercontent.com/npu3pak/ios-lib-overlays/master/Images/ViewController.gif)
### Displaying inside a View Controller

```swift
import Overlays
Expand All @@ -56,10 +56,10 @@ class CustomOverlayViewController: UIViewController {
}
```

### Atop of a View

![Example image](https://raw.githubusercontent.com/npu3pak/ios-lib-overlays/master/Images/ViewController.gif)

### Displaying atop of a View

```swift
import Overlays
...
Expand All @@ -76,9 +76,9 @@ func hide() {
...
```

### Above the keyboard
![Example image](https://raw.githubusercontent.com/npu3pak/ios-lib-overlays/master/Images/ViewController.gif)

![Example image](https://raw.githubusercontent.com/npu3pak/ios-lib-overlays/master/Images/AboveKeyboard.gif)
### Displaying above the keyboard

```swift
import Overlays
Expand Down Expand Up @@ -107,9 +107,7 @@ class CustomOverlayViewController: UIViewController {
}
```

## Example

To run the example project, clone the repo, and run `pod install` from the Example directory first.
![Example image](https://raw.githubusercontent.com/npu3pak/ios-lib-overlays/master/Images/AboveKeyboard.gif)

## Author

Expand Down

0 comments on commit 6f0230b

Please sign in to comment.