Update podspec file and README

nicol3a · Nov 13, 2018 · ba63ff2 · ba63ff2
1 parent de1afa5
commit ba63ff2
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 13 deletions.
diff --git a/NBBottomSheet.podspec b/NBBottomSheet.podspec
@@ -5,7 +5,7 @@ Pod::Spec.new do |spec|
   spec.homepage         = 'https://github.com/nicol3a/NBBottomSheet'
   spec.authors          = { 'Nicolas Bichon' => '[email protected]' }
   spec.summary          = 'An iOS library that presents a bottom sheet using Auto Layout.'
-  spec.source           = { :git => 'https://github.com/nicol3a/NBBottomSheet', :tag => 'v1.0.0' }
+  spec.source           = { :git => 'https://github.com/nicol3a/NBBottomSheet.git', :tag => '1.0.0' }
   spec.source_files     = 'NBBottomSheet/NBBottomSheet/Sources/**/*.{h,m,swift}'
   spec.framework        = 'Foundation', 'UIKit'
   spec.platform         = :ios, '9.0'

diff --git a/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetConfiguration.swift b/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetConfiguration.swift
@@ -1,6 +1,6 @@
 //
 //  NBBottomSheetConfiguration.swift
-//  NBIBottomSheet
+//  NBBottomSheet
 //
 //  Created by Bichon, Nicolas on 2018-10-30.
 //

diff --git a/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetController.swift b/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetController.swift
@@ -1,6 +1,6 @@
 //
 //  NBBottomSheetController.swift
-//  NBIBottomSheet
+//  NBBottomSheet
 //
 //  Created by Bichon, Nicolas on 2018-10-02.
 //

diff --git a/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetDismissalTransition.swift b/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetDismissalTransition.swift
@@ -1,6 +1,6 @@
 //
 //  NBBottomSheetDismissalTransition.swift
-//  NBIBottomSheet
+//  NBBottomSheet
 //
 //  Created by Bichon, Nicolas on 2018-10-02.
 //

diff --git a/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetPresentationController.swift b/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetPresentationController.swift
@@ -1,6 +1,6 @@
 //
 //  NBBottomSheetPresentationController.swift
-//  NBIBottomSheet
+//  NBBottomSheet
 //
 //  Created by Bichon, Nicolas on 2018-10-02.
 //

diff --git a/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetPresentationTransition.swift b/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetPresentationTransition.swift
@@ -1,6 +1,6 @@
 //
 //  NBBottomSheetPresentationTransition.swift
-//  NBIBottomSheet
+//  NBBottomSheet
 //
 //  Created by Bichon, Nicolas on 2018-10-02.
 //

diff --git a/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetTransitioningDelegate.swift b/NBBottomSheet/NBBottomSheet/Sources/NBBottomSheetTransitioningDelegate.swift
@@ -1,6 +1,6 @@
 //
 //  NBBottomSheetTransitioningDelegate.swift
-//  NBIBottomSheet
+//  NBBottomSheet
 //
 //  Created by Bichon, Nicolas on 2018-10-02.
 //

diff --git a/NBBottomSheet/NBBottomSheet/Sources/NBConfiguration.swift b/NBBottomSheet/NBBottomSheet/Sources/NBConfiguration.swift
@@ -1,6 +1,6 @@
 //
 //  NBConfiguration.swift
-//  NBIBottomSheet
+//  NBBottomSheet
 //
 //  Created by Bichon, Nicolas on 2018-10-30.
 //

diff --git a/README.md b/README.md
@@ -1,8 +1,16 @@
 # NBBottomSheet
 
-**NBBottomSheet** is an open-source iOS library in Swift that lets you present a bottom sheet. It works with Auto Layout to calculate the size of the bottom sheet.
+[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg)](https://github.com/Carthage/Carthage)
+[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/NBBottomSheet.svg)](http://cocoapods.org/pods/NBBottomSheet)
+[![Swift 4.2](https://img.shields.io/badge/Swift-4.2-orange.svg?style=flat)](https://developer.apple.com/swift/)
+[![Platform](https://img.shields.io/cocoapods/p/NBBottomSheet.svg)](http://www.apple.com/ios/)
+[![License](https://img.shields.io/github/license/nicol3a/NBBottomSheet.svg)](https://github.com/nicol3a/NBBottomSheet/blob/master/LICENSE)
 
-![Demo](demo.gif)
+**NBBottomSheet** is an open-source iOS library that lets you present a bottom sheet using Auto Layout.
+
+The size of the bottom sheet is calculated based on the Auto Layout constraints of the view.
+
+![Demo](https://github.com/nicol3a/NBBottomSheet/blob/master/demo.gif)
 
 ## Requirements
 
@@ -41,9 +49,17 @@ To integrate NBBottomSheet into your Xcode project using [Carthage](https://gith
 github "nicol3a/NBBottomSheet" ~> 1.0.0
 ```
 
+Then, run the following command:
+
+```bash
+$ carthage update
+```
+
+Drag the built `NBBottomSheet.framework` from the Carthage build folder into the “Embedded Binaries” section in the "General" panel of the application target.
+
 ### Manually
 
-Drag the `NBBottomSheet.xcodeproj` file into your project and add the `NBBottomSheet.framework` in the *Embedded Binaries* section.
+Drag the `NBBottomSheet.xcodeproj` file into your project and add the `NBBottomSheet.framework` in the "Embedded Binaries" section in the "General" panel of the application target.
 
 ## Usage
 
@@ -73,11 +89,11 @@ let bottomSheetController = NBBottomSheetController(configuration: configuration
 
 The library relies on Auto Layout to calculate the size of the view controller being presented.
 
-You can either use Storyboards or xibs to create your view controller and set the Size to *Freeform* (*Simulated Metrics* section in the *Attributes inspector* panel), or you can create your view in code.
+You can either use Storyboards or xibs to create your view controller and set the Size to "Freeform" ("Simulated Metrics" section in the "Attributes inspector" panel), or you can create your view in code.
 
 ## License
 
-NBBottomSheet is available under the MIT license. See the [`LICENSE`](LICENSE) file for more information.
+NBBottomSheet is available under the MIT license. See the [`LICENSE`](https://github.com/nicol3a/NBBottomSheet/blob/master/LICENSE) file for more information.
 
 ## Acknowledgements