Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 90 lines (53 sloc) 5.1 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
2c587d7 @alloy Update README with content from Manfred.
alloy authored
3 CocoaPods manages library dependencies for your Xcode project.
ed68b46 @alloy More work on README.
alloy authored
4
2c587d7 @alloy Update README with content from Manfred.
alloy authored
5 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
6
2c587d7 @alloy Update README with content from Manfred.
alloy authored
7 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
8
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
9 See [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
10
ed68b46 @alloy More work on README.
alloy authored
11
2c587d7 @alloy Update README with content from Manfred.
alloy authored
12 ## Installation
a2ea23f @alloy Add link to wiki.
alloy authored
13
2c587d7 @alloy Update README with content from Manfred.
alloy authored
14 Downloading and installing CocoaPods only takes a few minutes.
ed68b46 @alloy More work on README.
alloy authored
15
2c587d7 @alloy Update README with content from Manfred.
alloy authored
16 CocoaPods runs on [MacRuby](http://macruby.org). If you don't have a recent version of MacRuby installed you will need to download it. CocoaPods works best on version 0.10.
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
17
2c587d7 @alloy Update README with content from Manfred.
alloy authored
18 $ curl -O http://www.macruby.org/files/MacRuby%200.10.zip
19 $ open MacRuby%200.10.zip
20 # open MacRuby\ 0.10/MacRuby\ 0.10.pkg
21
22 After that you can install CocoaPods itself.
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
23
cdd1343 @alloy Update README to point to the MacRuby installer pkg and a link to a wiki...
alloy authored
24 $ sudo macgem install cocoapods
ed68b46 @alloy More work on README.
alloy authored
25 $ pod setup
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
26
ae67853 @alloy Improve handover from one section to the next. (Suggestion by Florian.)
alloy authored
27 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
28
7b12dd8 @alloy Add note about compiling source.
alloy authored
29
ae67853 @alloy Improve handover from one section to the next. (Suggestion by Florian.)
alloy authored
30 ## Adding it to your project
7b12dd8 @alloy Add note about compiling source.
alloy authored
31
2c587d7 @alloy Update README with content from Manfred.
alloy authored
32 Search for Pods by name or description.
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
33
2c587d7 @alloy Update README with content from Manfred.
alloy authored
34 $ pod search asi
35 ==> ASIHTTPRequest (1.8.1)
36 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 alloy/c...
floere authored
37
2c587d7 @alloy Update README with content from Manfred.
alloy authored
38 ==> ASIWebPageRequest (1.8.1)
39 The ASIWebPageRequest class included with ASIHTTPRequest lets you download
40 complete webpages, including external resources like images and stylesheets.
5f63109 @alloy Add a bit more info to the readme.
alloy authored
41
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
42 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
43
2c587d7 @alloy Update README with content from Manfred.
alloy authored
44 $ edit Podfile
45 platform :ios
46 dependency 'JSONKit', '~> 1.4'
47 dependency 'Reachability', '~> 2.0.4'
b630722 @alloy A bit more.
alloy authored
48
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
49 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
50
2c587d7 @alloy Update README with content from Manfred.
alloy authored
51 $ pod install App.xcodeproj
29dacf4 @alloy Explain what users can do to contribute.
alloy authored
52
80c290b @alloy Clarify that ‘App.xcodeproj’ has to be substituted by the user’s applica...
alloy authored
53 _Where ‘App.xcodeproj’ is the name of your actual application project._
54
2c587d7 @alloy Update README with content from Manfred.
alloy authored
55 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
56
2c587d7 @alloy Update README with content from Manfred.
alloy authored
57 $ open App.xcworkspace
5f63109 @alloy Add a bit more info to the readme.
alloy authored
58
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
59 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
60
2c587d7 @alloy Update README with content from Manfred.
alloy authored
61 $ pod spec create Peanuts
62 $ edit Peanuts.podspec
63 $ pod spec lint Peanuts.podspec
11a8a32 @alloy Add IRC channel to README
alloy authored
64
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
65 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
66
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
67 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
68
69
2c587d7 @alloy Update README with content from Manfred.
alloy authored
70 ## Collaborate
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
71
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
72 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
73
2c587d7 @alloy Update README with content from Manfred.
alloy authored
74 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
75
80c290b @alloy Clarify that ‘App.xcodeproj’ has to be substituted by the user’s applica...
alloy authored
76 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
77
78
79 # Endorsements
80
81 * “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)
82 * “Are you doing open source iOS components? You really should support @CocoaPodsOrg!” –– [Matthias Tretter](http://twitter.com/#!/myell0w/status/134955697740840961)
83 * “So glad someone has finally done this...” –– [Tom Wilson](http://news.ycombinator.com/item?id=3009349)
84 * “Anybody who has tasted the coolness of RubyGems (and @gembundler) understands how cool CocoaPods might be.” –– [StuFF mc](http://twitter.com/#!/stuffmc/status/115374231591731200)
85 * “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)
86 * “Really digg how @alloy is building a potential game changer” –– [Klaas Speller](https://twitter.com/#!/spllr/status/115914209438601216)
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also alloy/c...
floere authored
87 * “@alloy's making an Objective-C package manager: github.com/CocoaPods/CocoaPods. 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
88 * “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
89 * “This is awesome, I love endorsements!” –– [Appie Durán](http://twitter.com/#!/AppieDuran)
Something went wrong with that request. Please try again.