Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisakers committed May 28, 2018
1 parent 1494ba3 commit 29222e1
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
Binary file added .assets/demo_close_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 5 additions & 4 deletions .generate-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ set -e

MODULE_VERSION=$1
OUTPUT=$2
SWIFT_VERSION="4.0"
SWIFT_VERSION="4.1"
AUTHOR="Alexis Aubry"
AUTHOR_URL="https://twitter.com/_alexaubry"
MODULE_NAME="BulletinBoard"
COPYRIGHT="Copyright © 2017 $AUTHOR. Available under the MIT License."
MODULE_NAME="BLTNBoard"
COPYRIGHT="Copyright © 2017 - present $AUTHOR. Available under the MIT License."
GITHUB_URL="https://github.com/alexaubry/BulletinBoard"
GH_PAGES_URL="https://alexaubry.github.io/BulletinBoard"

Expand All @@ -24,4 +24,5 @@ jazzy \
-o "$OUTPUT"\
--min-acl public \
--use-safe-filenames \
--exclude="Sources/Support/*.swift"
--exclude="Sources/Support/*.swift" \
--documentation="guides/*.md"
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BulletinBoard Beta
# BulletinBoard

[![CI Status](https://travis-ci.org/alexaubry/BulletinBoard.svg?branch=master)](https://travis-ci.org/alexaubry/BulletinBoard)
[![Version](https://img.shields.io/cocoapods/v/BulletinBoard.svg?style=flat)](https://cocoapods.org/pods/BulletinBoard)
Expand Down Expand Up @@ -262,7 +262,7 @@ If you set the `isDismissable` property to `true`, the user will be able to dism

By default, a close button will be displayed when the item can be dismissed. If you don't want this behavior, you can set the `requiresCloseButton` property to `false`. This is useful when the bulletin already provides an action button to close the item (such as a “Done“ button).

![Dimming View](https://raw.githubusercontent.com/alexaubry/BulletinBoard/master/.assets/demo_background_styles.png)
![Dismissal](https://raw.githubusercontent.com/alexaubry/BulletinBoard/master/.assets/demo_close_button.png)

## Creating Custom Items

Expand Down
File renamed without changes.

0 comments on commit 29222e1

Please sign in to comment.