Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 128 lines (82 sloc) 7.128 kb
2c587d7 @alloy Update README with content from Manfred.
alloy authored
1 # CocoaPods – an Objective-C library manager
ed68b46 @alloy More work on README.
alloy authored
2
1a9c919 @fabiopelosin [README] Show the status of Xcodeproj.
fabiopelosin authored
3 | CocoaPods | Xcodeproj | Specs |
4 | :---: | :---: | :---: |
5 [![Master Build Status](https://secure.travis-ci.org/CocoaPods/CocoaPods.png?branch=master)](https://secure.travis-ci.org/CocoaPods/CocoaPods)|[![Build Status](https://secure.travis-ci.org/CocoaPods/Xcodeproj.png?branch=master)](http://travis-ci.org/CocoaPods/Xcodeproj)|[![Build Status](https://secure.travis-ci.org/CocoaPods/Specs.png?branch=master)](http://travis-ci.org/CocoaPods/Specs)
db4a4d2 @fabiopelosin Label status images and added CocoaPods/Specs status.
fabiopelosin authored
6
1902fa3 @alloy Add build status image.
alloy authored
7
2c587d7 @alloy Update README with content from Manfred.
alloy authored
8 CocoaPods manages library dependencies for your Xcode project.
ed68b46 @alloy More work on README.
alloy authored
9
adcb74d @mk Adding links to homepage and mailing list
mk authored
10 Homepage: [http://cocoapods.org/](http://cocoapods.org/)
11 Twitter: [@CocoaPodsOrg](http://twitter.com/CocoaPodsOrg)
12 Mailing List: [http://groups.google.com/group/cocoapods](http://groups.google.com/group/cocoapods)
13
2c587d7 @alloy Update README with content from Manfred.
alloy authored
14 You specify the dependencies for your project in one easy text file. CocoaPods resolves dependencies between libraries, fetches source code for the dependencies, and creates and maintains an Xcode workspace to build your project.
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
15
2c587d7 @alloy Update README with content from Manfred.
alloy authored
16 Ultimately, the goal is to improve discoverability of, and engagement in, third party open-source libraries, by creating a more centralized ecosystem.
ed68b46 @alloy More work on README.
alloy authored
17
28ddde2 @alloy Add a link to @subdigital’s NSScreencast episode about creating a podspe...
alloy authored
18 See the [NSScreencast](https://twitter.com/NSScreencast) episode about [using CocoaPods](http://nsscreencast.com/episodes/5-cocoapods) for a quick overview on how to get started or [create a Pod specification](http://nsscreencast.com/episodes/28-creating-a-cocoapod), or [the wiki](https://github.com/CocoaPods/CocoaPods/wiki) for more in depth information on several topics.
87e1a0b @alloy Add link to wiki to the README
alloy authored
19
bad8d13 @alloy [README] Add link to CHANGELOG and remove outdated irc info.
alloy authored
20 Or, if you’re already using CocoaPods, you can find the changelog [here](https://github.com/CocoaPods/CocoaPods/blob/master/CHANGELOG.md), which contains an overview of the changes in recent versions.
21
ed68b46 @alloy More work on README.
alloy authored
22
2c587d7 @alloy Update README with content from Manfred.
alloy authored
23 ## Installation
a2ea23f @alloy Add link to wiki.
alloy authored
24
2c587d7 @alloy Update README with content from Manfred.
alloy authored
25 Downloading and installing CocoaPods only takes a few minutes.
ed68b46 @alloy More work on README.
alloy authored
26
b99f768 @alloy You know I :heart: you, @MacRuby, we've had a good run. But this ride ha...
alloy authored
27 CocoaPods runs on [Ruby](http://www.ruby-lang.org/en/). To install it run the following commands:
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
28
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
29 ```
1059c1b @fabiopelosin Update develop
fabiopelosin authored
30 $ [sudo] gem install cocoapods
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
31 ```
32
33 If you want to have CocoaPods generate documentation for each library, then install the [appledoc](http://gentlebytes.com/appledoc/) tool:
34
35 ```
36 $ brew install appledoc --HEAD
37 $ ln -sf "`brew --prefix`/Cellar/appledoc/HEAD/Templates" ~/Library/Application\ Support/appledoc
38 ```
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
39
ae67853 @alloy Improve handover from one section to the next. (Suggestion by Florian.)
alloy authored
40 Now that you've got CocoaPods installed you can easily add it to your project.
2c587d7 @alloy Update README with content from Manfred.
alloy authored
41
7ba66f5 @alloy Small styling tweak.
alloy authored
42 **NOTES**
15779eb @alloy Add install note about older RubyGems.
alloy authored
43
497ee26 @jaydee3 Updated installation notes.
jaydee3 authored
44 1. If you're using a fresh out of the box Mac with Lion using Xcode from the Mac App Store, you will need to install the Command Line Tools for Xcode first: [here](https://developer.apple.com/downloads/index.action)
45 Or from `Xcode > Settings > Downloads > Components > Command Line Tools`
7ba66f5 @alloy Small styling tweak.
alloy authored
46
9b5788e @alloy Exit early when using an old RubyGems version (< 1.4.0).
alloy authored
47 2. CocoaPods re-uses some of the RubyGems classes. If you have a version older than 1.4.0, you will have to update RubyGems: `$ gem update --system`.
15779eb @alloy Add install note about older RubyGems.
alloy authored
48
7b12dd8 @alloy Add note about compiling source.
alloy authored
49
ae67853 @alloy Improve handover from one section to the next. (Suggestion by Florian.)
alloy authored
50 ## Adding it to your project
7b12dd8 @alloy Add note about compiling source.
alloy authored
51
2c587d7 @alloy Update README with content from Manfred.
alloy authored
52 Search for Pods by name or description.
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
53
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
54 ```
590ece6 @fabiopelosin [Readme] Update search example.
fabiopelosin authored
55 $ pod search json
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
56
590ece6 @fabiopelosin [Readme] Update search example.
fabiopelosin authored
57 --> JSONKit (1.4, 1.5pre)
58 A Very High Performance Objective-C JSON Library.
59 - Homepage: https://github.com/johnezang/JSONKit
60 - Source: https://github.com/johnezang/JSONKit.git
61
62 --> SBJson (2.2.3, 3.0.4, 3.1)
63 This library implements strict JSON parsing and generation in Objective-C.
64 - Homepage: http://stig.github.com/json-framework/
65 - Source: https://github.com/stig/json-framework.git
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
66 ```
5f63109 @alloy Add a bit more info to the readme.
alloy authored
67
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
68 After you've found your favorite dependencies you add them to your [Podfile](https://github.com/CocoaPods/CocoaPods/wiki/A-Podfile).
5f63109 @alloy Add a bit more info to the readme.
alloy authored
69
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
70 ```
71 $ edit Podfile
72 ```
73
74 ```ruby
75 platform :ios
0ee0ab1 @listrophy Deprecate `dependency'. Use `pod' now.
listrophy authored
76 pod 'JSONKit', '~> 1.4'
77 pod 'Reachability', '~> 2.0.4'
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
78 ```
b630722 @alloy A bit more.
alloy authored
79
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
80 And then you [install the dependencies](https://github.com/CocoaPods/CocoaPods/wiki/Creating-a-project-that-uses-CocoaPods) in your project.
5f63109 @alloy Add a bit more info to the readme.
alloy authored
81
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
82 ```
83 $ pod install
84 ```
54a79a0 @mk Update README.md with subsequent pod install instructions.
mk authored
85
2c587d7 @alloy Update README with content from Manfred.
alloy authored
86 Remember to always open the Xcode workspace instead of the project file when you're building.
5f63109 @alloy Add a bit more info to the readme.
alloy authored
87
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
88 ```
89 $ open App.xcworkspace
90 ```
5f63109 @alloy Add a bit more info to the readme.
alloy authored
91
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
92 Sometimes CocoaPods doesn't have a Pod for one of your dependencies yet. Fortunately [creating a Pod](https://github.com/CocoaPods/CocoaPods/wiki/A-pod-specification) is really easy.
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
93
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
94 ```
95 $ pod spec create Peanuts
96 $ edit Peanuts.podspec
97 $ pod spec lint Peanuts.podspec
98 ```
11a8a32 @alloy Add IRC channel to README
alloy authored
99
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
100 Once you've got it running [create a ticket](https://github.com/CocoaPods/CocoaPods/issues) and upload the Pod. If you're familiar with Git you can also fork the [CocoaPods specs](https://github.com/CocoaPods/Specs) repository and send a pull request. We really love contributions!
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
101
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
102 There are several other ways to start using **any** library without a Pod specification, which can be seen in the [SSCatalog example](https://github.com/CocoaPods/CocoaPods/blob/master/examples/SSCatalog/Podfile).
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
103
104
2c587d7 @alloy Update README with content from Manfred.
alloy authored
105 ## Collaborate
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
106
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
107 All CocoaPods development happens on GitHub, there is a repository for [CocoaPods](https://github.com/CocoaPods/CocoaPods) and one for the [CocoaPods specs](https://github.com/CocoaPods/Specs). Contributing patches or Pods is really easy and gratifying. You even get push access when one of your specs or patches is accepted.
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
108
2c587d7 @alloy Update README with content from Manfred.
alloy authored
109 Follow [@CocoaPodsOrg](http://twitter.com/CocoaPodsOrg) to get up to date information about what's going on in the CocoaPods world.
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
110
6c00b4e @alloy Add endorsements to README. Closes #55.
alloy authored
111
24a070e @alloy Add donations.
alloy authored
112 # Donations
113
114 * [@fngtps](http://twitter.com/fngtps) is donating time to work on the design of the forthcoming cocoapods.org website and donated the money to hire [Max Steenbergen](http://twitter.com/maxsteenbergen) to design [an icon](http://drbl.in/cpmL) for it.
115 * [@sauspiel](http://twitter.com/Sauspiel) uses CocoaPods for their games and have hired me to add features and specs they needed. These are Nimbus, QuincyKit, and HockeyKit. For the [Nimbus spec](https://github.com/CocoaPods/Specs/blob/master/Nimbus/0.9.0/Nimbus.podspec), the ‘subspecs’ feature was added.
116
6c00b4e @alloy Add endorsements to README. Closes #55.
alloy authored
117 # Endorsements
118
119 * “I am crazy excited about this. With the growing number of Objective-C libraries, this will make things so much better.” –– [Sam Soffes](http://news.ycombinator.com/item?id=3009154)
120 * “Are you doing open source iOS components? You really should support @CocoaPodsOrg!” –– [Matthias Tretter](http://twitter.com/#!/myell0w/status/134955697740840961)
121 * “So glad someone has finally done this...” –– [Tom Wilson](http://news.ycombinator.com/item?id=3009349)
122 * “Anybody who has tasted the coolness of RubyGems (and @gembundler) understands how cool CocoaPods might be.” –– [StuFF mc](http://twitter.com/#!/stuffmc/status/115374231591731200)
123 * “I will be working on getting several of my Objective-C libraries ready for CocoaPods this week!” –– [Luke Redpath](http://twitter.com/#!/lukeredpath/status/115510581921988608)
124 * “Really digg how @alloy is building a potential game changer” –– [Klaas Speller](https://twitter.com/#!/spllr/status/115914209438601216)
6cf539a @alloy Include examples in CHANGELOG.
alloy authored
125 * “@alloy's making an Objective-C package manager. This is fantastic news kids!” –– [Josh Abernathy](http://twitter.com/#!/joshaber/status/115273577703555073)
dba5cbf @alloy A few more, now back to serious stuff.
alloy authored
126 * “A package manager for Cocoa/Objective-C, built with @MacRuby. Awesomeness!” –– [Johannes Fahrenkrug](http://twitter.com/#!/jfahrenkrug/status/115303240286998528)
6c00b4e @alloy Add endorsements to README. Closes #55.
alloy authored
127 * “This is awesome, I love endorsements!” –– [Appie Durán](http://twitter.com/#!/AppieDuran)
Something went wrong with that request. Please try again.