Skip to content

Commit

Permalink
Update metadata and guides for v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisakers committed Oct 5, 2017
1 parent 73f5130 commit b307b58
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 1 deletion.
Binary file added .assets/demo_activity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
<!--- Please describe how you tested your changes. --->
<!-- If you are submitting a link to your app for the README, you can omit this section. -->

### Description
<!--- Describe your changes in detail. -->
1 change: 1 addition & 0 deletions BulletinBoard.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Pod::Spec.new do |s|
s.description = <<-DESC
BulletinBoard is an iOS library that generates and manages contextual cards displayed at the bottom of the screen. It is especially well suited for quick user interactions such as onboarding screens or configuration.
It has an interface similar to the cards displayed by iOS for AirPods, Apple TV configuration and NFC tag scanning.
It has built-in support for accessibility features such as VoiceOver and Switch Control.
DESC
s.homepage = "https://github.com/alexaubry/BulletinBoard"
s.license = { :type => "MIT", :file => "LICENSE" }
Expand Down
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ BulletinBoard is an iOS library that generates and manages contextual cards disp

It has an interface similar to the cards displayed by iOS for AirPods, Apple TV configuration and NFC tag scanning.

It has built-in support for accessibility features such as VoiceOver and Switch Control.

Here are some screenshots showing what you can build with BulletinBoard:

![Demo Screenshots](https://raw.githubusercontent.com/alexaubry/BulletinBoard/master/.assets/demo_screenshots.png)
Expand All @@ -33,7 +35,7 @@ Build and run the `Instanimal` scheme to use it.

Here's a video showing it in action:

[![Watch Demo on YouTube](https://raw.githubusercontent.com/alexaubry/BulletinBoard/master/.assets/demo_thumbnail.png)](https://youtu.be/igNner7z13U)
[![Watch Demo on YouTube](https://raw.githubusercontent.com/alexaubry/BulletinBoard/master/.assets/demo_thumbnail.png)](https://youtu.be/36pFHov7MTE)

## Installation

Expand Down Expand Up @@ -210,6 +212,30 @@ This creates the following interaction:

![Next Item](https://raw.githubusercontent.com/alexaubry/BulletinBoard/master/.assets/demo_segue.png)

##

If you need to perform a task between the moment the user taps a button and the moment you'll be able to change the presented item, you can call `displayActivityIndicator()` method on the item manager to hide the current card and display an activity indicator.

This is especially useful if you need to fetch data from a server (in-app purchase price, subscription status, ...) or save data (e.g. Core Data).

Once your task is finished, call one of the methods described in [Changing the Presented Item](#changing-the-presented-item).

**Example**:

~~~swift
page.actionHandler = { (item: PageBulletinItem) in
item.manager?.displayActivityIndicator()
// do your task
// ...
// when your task is finished, transition to the appropriate bulletin item
item.displayNextItem()
}
~~~

This creates the following interaction:

![Activity Indicator](https://raw.githubusercontent.com/alexaubry/BulletinBoard/master/.assets/demo_activity.png)

## Automatic Dismissal

If you set the `isDismissable` property to `true`, the user will be able to dismiss the bulletin by tapping outside of the card.
Expand Down Expand Up @@ -261,6 +287,9 @@ Make sure to read these guides before getting started:
- [Code of Conduct](https://github.com/alexaubry/BulletinBoard/blob/master/CODE_OF_CONDUCT.md)
- [Contribution Guidelines](https://github.com/alexaubry/BulletinBoard/blob/master/CONTRIBUTING.md)

## Apps Using _BulletinBoard_

Feel free to submit a PR if you’re using this library in your apps.

## Author

Expand Down

0 comments on commit b307b58

Please sign in to comment.