Skip to content
This repository was archived by the owner on Sep 19, 2024. It is now read-only.

Commit 7883aef

Browse files
committed
Update Readme
- Installation instructions - Badges
1 parent 19a3e26 commit 7883aef

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

Readme.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
1-
# R.swift.Library ![Version](https://img.shields.io/cocoapods/v/R.swift.Library.svg?style=flat) ![License](https://img.shields.io/cocoapods/l/R.swift.Library.svg?style=flat) ![Platform](https://img.shields.io/cocoapods/p/R.swift.Library.svg?style=flat)
1+
# R.swift.Library [![Version](https://img.shields.io/cocoapods/v/R.swift.Library.svg?style=flat)](http://cocoapods.org/?q=R.swift.Library) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![License](https://img.shields.io/cocoapods/l/R.swift.Library.svg?style=flat)](blob/master/License) ![Platform](https://img.shields.io/cocoapods/p/R.swift.Library.svg?style=flat)
22

33
_Library containing types supporting code generated by [R.swift](https://github.com/mac-cain13/R.swift)_
44

5+
## Why use this?
6+
7+
Regular users probably want to include this library to use [R.swift](https://github.com/mac-cain13/R.swift). Developers of other libraries can use this library to extend upon the types and code R.swift generates and uses.
8+
9+
## Installation
10+
11+
### CocoaPods (recommended)
12+
13+
_**Be aware:** If you just want to use R.swift follow the install instructions for R.swift._
14+
15+
1. Add `pod 'R.swift.Library'` to your [Podfile](http://cocoapods.org/#get_started)
16+
2. Run `pod install`
17+
18+
### Carthage
19+
20+
1. Add `github "mac-cain13/R.swift.Library"` to your [Cartfile](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#cartfile)
21+
2. Run `carthage`
22+
523
## License
624

7-
R.swift and R.swift.Library are created by [Mathijs Kadijk](https://github.com/mac-cain13) and released under a [MIT License](License).
25+
[R.swift](https://github.com/mac-cain13/R.swift) and [R.swift.Library](https://github.com/mac-cain13/R.swift.Library) are created by [Mathijs Kadijk](https://github.com/mac-cain13) and released under a [MIT License](License).

0 commit comments

Comments
 (0)