From e93787e0b57917676c317e6f5a875908afc184ce Mon Sep 17 00:00:00 2001 From: Paolo Date: Thu, 12 Oct 2017 21:36:32 +0200 Subject: [PATCH] README Edited --- README.md | 248 +++++++++++++++++++++++++++--------------------------- 1 file changed, 125 insertions(+), 123 deletions(-) diff --git a/README.md b/README.md index 576c6b7..87ee9ec 100644 --- a/README.md +++ b/README.md @@ -1,123 +1,125 @@ -[![CocoaPods Version](https://img.shields.io/cocoapods/v/Cards.svg?style=flat)](http://cocoadocs.org/docsets/Cards) -[![Platform](https://img.shields.io/cocoapods/p/Cards.svg?style=flat)](http://cocoadocs.org/docsets/Cards) - - -![Cards](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/Logo.png) - -Cards brings to XCode the card views you can see in the new iOS XI Appstore. - -## Getting Started - -### Storyboard -- Go to **main.storyboard** and add a **blank UIView** -- Open the **Identity Inspector** and type '**CardHighligth**' the '**class**' field -- Switch to the **Attributes Inspector** and **configure** it as you like. - -### Code -```swift -// Aspect Ratio of 5:6 is preferred -let card = CardHighlight(frame: CGRect(x: 100, y: 100, width: 200, height: 240)) -card.backgroundColor = UIColor(red: 0, green: 94/255, blue: 112/255, alpha: 1) -card.backgroundImage = UIImage(named: "flBackground") // Comment this for the first view -card.icon = UIImage(named: "flappy") -card.title = "Welcome to XI Cards !" -card.itemTitle = "Flappy Bird" -card.itemSubtitle = "Flap That !" -view.addSubview(card) -``` - -![GetStarted](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/GetStarted.png) - -## Prerequisites - -- **XCode 9.0** or newer -- **Swift 4.0** - -## Installation - -### Cocoapods -``` -use_frameworks! -pod 'Cards' -``` -### Manual -- **Download** the repo -- ⌘C ⌘V the **'Cards' folder** in your project -- In your **Project's Info** go to '**Build Phases**' -- Open '**Compile Sources**' and **add all the files** in the folder - -## Overview - -![Overview](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/Overview.png) -![Overview](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/CardPlayer.gif) -![Overview](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/CardGroupSliding.gif) - - -## Customization - -```swift -//Shadow settings -var shadowBlur: CGFloat -var shadowOpacity: Float -var shadowColor: UIColor -var backgroundImage: UIImage? -var backgroundColor: UIColor - -var textColor: UIColor //Color used for the labels -var insets: CGFloat //Spacing between content and card borders -var cardRadius: CGFloat //Corner radius of the card -var icons: [UIImage]? //DataSource for CardGroupSliding -var blurEffect: UIBlurEffectStyle //Blur effect of CardGroup -``` - -## Usage - -### CardPlayer -```swift -let card = CardPlayer(frame: CGRect(x: 40, y: 50, width: 300 , height: 360)) -card.textColor = UIColor.black -card.videoSource = URL(string: "http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4") -self.addChildViewController(card.player) /// IMPORTANT: Don't forget this - -card.playerCover = UIImage(named: "mvBackground")! // Shows while the player is loading -card.playImage = UIImage(named: "CardPlayerPlayIcon")! // Play button icon - -card.isAutoplayEnabled = true -card.shouldRestartVideoWhenPlaybackEnds = true - -card.title = "Big Buck Bunny" -card.subtitle = "Inside the extraordinary world of Buck Bunny" -card.category = "today's movie" - -view.addSubview(card) -``` - -### CardGroupSliding -```swift - let icons: [UIImage] = [ - - UIImage(named: "grBackground")!, - UIImage(named: "background")!, - UIImage(named: "flappy")!, - UIImage(named: "flBackground")!, - UIImage(named: "icon")!, - UIImage(named: "mvBackground")! - - ] // Data source for CardGroupSliding - - let card = CardGroupSliding(frame: CGRect(x: 40, y: 50, width: 300 , height: 360)) - card.textColor = UIColor.black - - card.icons = icons - card.iconsSize = 60 - card.iconsRadius = 30 - - card.title = "from the editors" - card.subtitle = "Welcome to XI Cards !" - - view.addSubview(card) -``` - -## License - -Cards is released under the [MIT License](LICENSE). +[![CocoaPods Version](https://img.shields.io/cocoapods/v/Cards.svg?style=flat)](http://cocoadocs.org/docsets/Cards) +[![Platform](https://img.shields.io/cocoapods/p/Cards.svg?style=flat)](http://cocoadocs.org/docsets/Cards) +![Cards](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/Logo.png) + +Cards brings to XCode the card views you can see in the new iOS XI Appstore. + +## Getting Started + +### Storyboard +- Go to **main.storyboard** and add a **blank UIView** +- Open the **Identity Inspector** and type '**CardHighligth**' the '**class**' field +- Switch to the **Attributes Inspector** and **configure** it as you like. + +### Code +```swift +// Aspect Ratio of 5:6 is preferred +let card = CardHighlight(frame: CGRect(x: 100, y: 100, width: 200, height: 240)) +card.backgroundColor = UIColor(red: 0, green: 94/255, blue: 112/255, alpha: 1) +card.backgroundImage = UIImage(named: "flBackground") // Comment this for the first view +card.icon = UIImage(named: "flappy") +card.title = "Welcome to XI Cards !" +card.itemTitle = "Flappy Bird" +card.itemSubtitle = "Flap That !" +view.addSubview(card) +``` + +![GetStarted](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/GetStarted.png) + +## Prerequisites + +- **XCode 9.0** or newer +- **Swift 4.0** + +## Installation + +### Cocoapods +``` +use_frameworks! +pod 'Cards' +``` +### Manual +- **Download** the repo +- ⌘C ⌘V the **'Cards' folder** in your project +- In your **Project's Info** go to '**Build Phases**' +- Open '**Compile Sources**' and **add all the files** in the folder + +## Overview + +![Overview](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/Overview.png) +![Overview](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/CardPlayer.gif) +![Overview](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Images/CardGroupSliding.gif) + + +## Customization + +```swift +//Shadow settings +var shadowBlur: CGFloat +var shadowOpacity: Float +var shadowColor: UIColor +var backgroundImage: UIImage? +var backgroundColor: UIColor + +var textColor: UIColor //Color used for the labels +var insets: CGFloat //Spacing between content and card borders +var cardRadius: CGFloat //Corner radius of the card +var icons: [UIImage]? //DataSource for CardGroupSliding +var blurEffect: UIBlurEffectStyle //Blur effect of CardGroup +``` + +## Usage + +### CardPlayer +```swift +let card = CardPlayer(frame: CGRect(x: 40, y: 50, width: 300 , height: 360)) +card.textColor = UIColor.black +card.videoSource = URL(string: "http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4") +self.addChildViewController(card.player) /// IMPORTANT: Don't forget this + +card.playerCover = UIImage(named: "mvBackground")! // Shows while the player is loading +card.playImage = UIImage(named: "CardPlayerPlayIcon")! // Play button icon + +card.isAutoplayEnabled = true +card.shouldRestartVideoWhenPlaybackEnds = true + +card.title = "Big Buck Bunny" +card.subtitle = "Inside the extraordinary world of Buck Bunny" +card.category = "today's movie" + +view.addSubview(card) +``` + +### CardGroupSliding +```swift + let icons: [UIImage] = [ + + UIImage(named: "grBackground")!, + UIImage(named: "background")!, + UIImage(named: "flappy")!, + UIImage(named: "flBackground")!, + UIImage(named: "icon")!, + UIImage(named: "mvBackground")! + + ] // Data source for CardGroupSliding + + let card = CardGroupSliding(frame: CGRect(x: 40, y: 50, width: 300 , height: 360)) + card.textColor = UIColor.black + + card.icons = icons + card.iconsSize = 60 + card.iconsRadius = 30 + + card.title = "from the editors" + card.subtitle = "Welcome to XI Cards !" + + view.addSubview(card) +``` + +## Thanksto + +- **Patrick Piemonte** - providing [Player](https://github.com/piemonte/Player) framework used in [CardPlayer.swift](https://raw.githubusercontent.com/PaoloCuscela/Cards/master/Cards/CardPlayer.swift) + +## License + +Cards is released under the [MIT License](LICENSE).