Skip to content
Newer
Older
100644 127 lines (81 sloc) 6.81 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
db4a4d2 @fabiopelosin Label status images and added CocoaPods/Specs status.
fabiopelosin authored
3 | Master branch | Develop branch | CocoaPods/Specs |
4 | :---: | :---: | :---: |
5 [![Master Build Status](https://secure.travis-ci.org/CocoaPods/CocoaPods.png?branch=master)](https://secure.travis-ci.org/CocoaPods/CocoaPods)|[![Develop Build Status](https://secure.travis-ci.org/CocoaPods/CocoaPods.png?branch=develop)](https://secure.travis-ci.org/CocoaPods/CocoaPods)|[![Build Status](https://secure.travis-ci.org/CocoaPods/Specs.png?branch=master)](http://travis-ci.org/CocoaPods/Specs)
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
915939d @alloy Add link to NSScreencast episode.
alloy authored
18 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
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 has c…
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
7ba66f5 @alloy Small styling tweak.
alloy 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
46 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
47
7b12dd8 @alloy Add note about compiling source.
alloy authored
48
ae67853 @alloy Improve handover from one section to the next. (Suggestion by Florian.)
alloy authored
49 ## Adding it to your project
7b12dd8 @alloy Add note about compiling source.
alloy authored
50
2c587d7 @alloy Update README with content from Manfred.
alloy authored
51 Search for Pods by name or description.
5889b9b @alloy Add an example PodSpec.rb file
alloy authored
52
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
53 ```
590ece6 @fabiopelosin [Readme] Update search example.
fabiopelosin authored
54 $ pod search json
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
55
590ece6 @fabiopelosin [Readme] Update search example.
fabiopelosin authored
56 --> JSONKit (1.4, 1.5pre)
57 A Very High Performance Objective-C JSON Library.
58 - Homepage: https://github.com/johnezang/JSONKit
59 - Source: https://github.com/johnezang/JSONKit.git
60
61 --> SBJson (2.2.3, 3.0.4, 3.1)
62 This library implements strict JSON parsing and generation in Objective-C.
63 - Homepage: http://stig.github.com/json-framework/
64 - Source: https://github.com/stig/json-framework.git
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
65 ```
5f63109 @alloy Add a bit more info to the readme.
alloy authored
66
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
67 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
68
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
69 ```
70 $ edit Podfile
71 ```
72
73 ```ruby
74 platform :ios
0ee0ab1 @listrophy Deprecate `dependency'. Use `pod' now.
listrophy authored
75 pod 'JSONKit', '~> 1.4'
76 pod 'Reachability', '~> 2.0.4'
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
77 ```
b630722 @alloy A bit more.
alloy authored
78
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
79 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
80
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
81 ```
82 $ pod install
83 ```
54a79a0 @mk Update README.md with subsequent pod install instructions.
mk authored
84
2c587d7 @alloy Update README with content from Manfred.
alloy authored
85 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
86
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
87 ```
88 $ open App.xcworkspace
89 ```
5f63109 @alloy Add a bit more info to the readme.
alloy authored
90
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
91 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
92
a5d34c8 @alloy Add a --force-doc option and add `appledoc` install note to README.
alloy authored
93 ```
94 $ pod spec create Peanuts
95 $ edit Peanuts.podspec
96 $ pod spec lint Peanuts.podspec
97 ```
11a8a32 @alloy Add IRC channel to README
alloy authored
98
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
99 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
100
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
101 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
102
103
2c587d7 @alloy Update README with content from Manfred.
alloy authored
104 ## Collaborate
4246891 @alloy Merge commands.md into README.md and add LICENSE (MIT).
alloy authored
105
7945c24 @floere Renamed links to alloy/cocoapods to CocoaPods/CocoaPods and also allo…
floere authored
106 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
107
2c587d7 @alloy Update README with content from Manfred.
alloy authored
108 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
109
6c00b4e @alloy Add endorsements to README. Closes #55.
alloy authored
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.