diff --git a/.assets/demo_close_button.png b/.assets/demo_close_button.png new file mode 100644 index 0000000..acc7e0b Binary files /dev/null and b/.assets/demo_close_button.png differ diff --git a/.generate-docs.sh b/.generate-docs.sh index 461402c..ccde9c1 100755 --- a/.generate-docs.sh +++ b/.generate-docs.sh @@ -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" @@ -24,4 +24,5 @@ jazzy \ -o "$OUTPUT"\ --min-acl public \ --use-safe-filenames \ - --exclude="Sources/Support/*.swift" + --exclude="Sources/Support/*.swift" \ + --documentation="guides/*.md" diff --git a/README.md b/README.md index ef07716..c36b801 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 diff --git a/guides/MigratingToV2.md b/guides/Migrating To V2.md similarity index 100% rename from guides/MigratingToV2.md rename to guides/Migrating To V2.md