Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rafiki270 authored Apr 9, 2018
1 parent fc53e46 commit a343b14
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Awesome is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:

```ruby
pod 'Awesome'
pod 'AwesomeEnum'
```

for Carthage just do:
Expand All @@ -34,14 +34,21 @@ github "LiveUI/Awesome"

## Usage

Import will be slightly different for Cocoapods/Carthage. Sorry for the confusion of names but some unreasonable fellow has already registered an `Awesome` pod before us :).

```swift
import AwesomeSwift // Cocoapods
import Awesome // Carthage
```

All icons are available through autogenerated enums like this:

```swift
let image = Awesome.solid.handScissors.asImage(size: 40.0)
// or
let image = Awesome.brand.apple.asImage(size: CGSize(width: 40, height: 40), color: .red, backgroundColor: .blue)
let image = Awesome.brand.android.asImage(size: CGSize(width: 40, height: 40), color: .red, backgroundColor: .blue) // :trollface:
// or
let attributedText = Awesome.regular.terminal.asAttributedText(fontSize: 17, color: .red, backgroundColor: .blue)
let attributedText = Awesome.regular.envelopeOpen.asAttributedText(fontSize: 17, color: .red, backgroundColor: .blue)
```

## Author
Expand Down

0 comments on commit a343b14

Please sign in to comment.