Skip to content

Commit

Permalink
Updated README and bumped version number
Browse files Browse the repository at this point in the history
  • Loading branch information
andreamazz committed Sep 4, 2014
1 parent e4a0ac7 commit 642bd1e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
4 changes: 2 additions & 2 deletions AMPopTip.podspec
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = "AMPopTip"
s.version = "0.3.1"
s.version = "0.4"
s.summary = "Animated popover, great for subtle UI tips and onboarding."

s.description = <<-DESC
Expand All @@ -13,7 +13,7 @@ Pod::Spec.new do |s|
s.homepage = "https://github.com/andreamazz/AMPopTip"
s.license = { :type => 'MIT', :file => 'LICENSE' }
s.author = { "Andrea Mazzini" => "[email protected]" }
s.source = { :git => "https://github.com/andreamazz/AMPopTip.git", :tag => '0.3.1' }
s.source = { :git => "https://github.com/andreamazz/AMPopTip.git", :tag => '0.4' }
s.platform = :ios, '7.0'
s.source_files = 'AMPopTip', '*.{h,m}'
s.requires_arc = true
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,29 @@ This popover can be used to leave subtle hints about your UI and provide fun loo
* Run ```open App.xcworkspace```

#Usage
The API is fairly straight forward, you can show and hide the popover at any time.

##Showing the popover
You must specify the text that you want to display alongside the popover direction, its max width, the view that will contain it and the frame of the view that the popover's arrow will point to.
```objc
self.popTip = [AMPopTip popTip];
[self.popTip showText:@"I'm a popover popping over" direction:AMPopTipDirectionUp maxWidth:200 inView:self.view fromFrame:someView.frame];
```
##Dismissing the popover
You can hide the popover by calling:
```objc
[self.popTip hide];
```
Or you can specify the duration of the popover:
```objc
[self.popTip showText:@"I'm a popover popping over" direction:AMPopTipDirectionUp maxWidth:200 inView:self.view fromFrame:someView.frame duration:3];
```
You can also let the user dismiss the popover by tapping on it:
```objc
self.popTip.shouldDismissOnTap = YES;
```

#Customization
Use the appearance proxy to customize the popover before creating the instance, or just use its public properties:
```objc
Expand Down

0 comments on commit 642bd1e

Please sign in to comment.