Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 127 lines (81 sloc) 6.63 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
1902fa3 @alloy Add build status image.
alloy authored
3 [![Build Status](https://secure.travis-ci.org/CocoaPods/CocoaPods.png)](https://secure.travis-ci.org/CocoaPods/CocoaPods)
4
2c587d7 @alloy Update README with content from Manfred.
alloy authored
5 CocoaPods manages library dependencies for your Xcode project.
ed68b46 @alloy More work on README.
alloy authored
6
adcb74d @mk Adding links to homepage and mailing list
mk authored
7 Homepage: [http://cocoapods.org/](http://cocoapods.org/)
8 Twitter: [@CocoaPodsOrg](http://twitter.com/CocoaPodsOrg)
9 Mailing List: [http://groups.google.com/group/cocoapods](http://groups.google.com/group/cocoapods)
10
2c587d7 @alloy Update README with content from Manfred.
alloy authored
11 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
12
2c587d7 @alloy Update README with content from Manfred.
alloy authored
13 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
14
915939d @alloy Add link to NSScreencast episode.
alloy authored
15 See the [NSScreencast episode about CocoaPods](http://nsscreencast.com/episodes/5-cocoapods) for a quick overview on how to get started, 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
16
ed68b46 @alloy More work on README.
alloy authored
17
2c587d7 @alloy Update README with content from Manfred.
alloy authored
18 ## Installation
a2ea23f @alloy Add link to wiki.
alloy authored
19
2c587d7 @alloy Update README with content from Manfred.
alloy authored
20 Downloading and installing CocoaPods only takes a few minutes.
ed68b46 @alloy More work on README.
alloy authored
21
b99f768 @alloy You know I :heart: you, @MacRuby, we've had a good run. But this ride…
alloy authored
22 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
23
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
24 ```
25 $ sudo gem install cocoapods
26 $ pod setup
27 ```
28
29 If you want to have CocoaPods generate documentation for each library, then install the [appledoc](http://gentlebytes.com/appledoc/) tool:
30
31 ```
32 $ brew install appledoc --HEAD
33 $ ln -sf "`brew --prefix`/Cellar/appledoc/HEAD/Templates" ~/Library/Application\ Support/appledoc
34 ```
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
35
ae67853 @alloy Improve handover from one section to the next. (Suggestion by Florian.)
alloy authored
36 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
37
15779eb @alloy Add install note about older RubyGems.
alloy authored
38 NOTE 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)
39
1e2f63d @alloy We need RubyGems >= 1.3.6
alloy authored
40 NOTE 2: CocoaPods re-uses some of the RubyGems 1.3.6 classes. If you have an older version (pre OS X 10.7), you will have to update RubyGems: `$ gem update --system`.
15779eb @alloy Add install note about older RubyGems.
alloy authored
41
7b12dd8 @alloy Add note about compiling source.
alloy authored
42
ae67853 @alloy Improve handover from one section to the next. (Suggestion by Florian.)
alloy authored
43 ## Adding it to your project
7b12dd8 @alloy Add note about compiling source.
alloy authored
44
2c587d7 @alloy Update README with content from Manfred.
alloy authored
45 Search for Pods by name or description.
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
46
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
47 ```
48 $ pod search asi
49 ==> ASIHTTPRequest (1.8.1)
50 Easy to use CFNetwork wrapper for HTTP requests, Objective-C, Mac OS X and iPhone
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
51
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
52 ==> ASIWebPageRequest (1.8.1)
53 The ASIWebPageRequest class included with ASIHTTPRequest lets you download
54 complete webpages, including external resources like images and stylesheets.
55 ```
5f63109 @alloy Add a bit more info to the readme.
alloy authored
56
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
57 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
58
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
59 ```
60 $ edit Podfile
61 ```
62
63 ```ruby
64 platform :ios
65 dependency 'JSONKit', '~> 1.4'
66 dependency 'Reachability', '~> 2.0.4'
67 ```
b630722 @alloy A bit more.
alloy authored
68
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
69 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
70
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
71 ```
72 $ pod install App.xcodeproj
73 ```
29dacf4 @alloy Explain what users can do to contribute.
alloy authored
74
80c290b @alloy Clarify that ‘App.xcodeproj’ has to be substituted by the user’s appl…
alloy authored
75 _Where ‘App.xcodeproj’ is the name of your actual application project._
76
54a79a0 @mk Update README.md with subsequent pod install instructions.
mk authored
77 The next time you change your Podfile, you can update your project by simply running:
78
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
79 ```
80 $ pod install
81 ```
54a79a0 @mk Update README.md with subsequent pod install instructions.
mk authored
82
2c587d7 @alloy Update README with content from Manfred.
alloy authored
83 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
84
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
85 ```
86 $ open App.xcworkspace
87 ```
5f63109 @alloy Add a bit more info to the readme.
alloy authored
88
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
89 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
90
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
91 ```
92 $ pod spec create Peanuts
93 $ edit Peanuts.podspec
94 $ pod spec lint Peanuts.podspec
95 ```
11a8a32 @alloy Add IRC channel to README
alloy authored
96
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
97 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
98
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
99 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
100
101
2c587d7 @alloy Update README with content from Manfred.
alloy authored
102 ## Collaborate
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
103
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
104 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
105
2c587d7 @alloy Update README with content from Manfred.
alloy authored
106 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
107
80c290b @alloy Clarify that ‘App.xcodeproj’ has to be substituted by the user’s appl…
alloy authored
108 If you're really oldschool and you want to discuss CocoaPods development you can join #cocoapods on irc.freenode.net.
6c00b4e @alloy Add endorsements to README. Closes #55.
alloy authored
109
110
24a070e @alloy Add donations.
alloy authored
111 # Donations
112
113 * [@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.
114 * [@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.
115
6c00b4e @alloy Add endorsements to README. Closes #55.
alloy authored
116 # Endorsements
117
118 * “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)
119 * “Are you doing open source iOS components? You really should support @CocoaPodsOrg!” –– [Matthias Tretter](http://twitter.com/#!/myell0w/status/134955697740840961)
120 * “So glad someone has finally done this...” –– [Tom Wilson](http://news.ycombinator.com/item?id=3009349)
121 * “Anybody who has tasted the coolness of RubyGems (and @gembundler) understands how cool CocoaPods might be.” –– [StuFF mc](http://twitter.com/#!/stuffmc/status/115374231591731200)
122 * “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)
123 * “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
124 * “@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
125 * “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
126 * “This is awesome, I love endorsements!” –– [Appie Durán](http://twitter.com/#!/AppieDuran)
Something went wrong with that request. Please try again.