CocoaPods/CocoaPods — Issue #149: Add documentation and improved licensing fields to podspec
Author: irrationalfab
Created: 2012-03-03 18:02:30+00:00
State: open
Labels: discussion

I'm suggesting to add this simple changes to `spec.rb` without introducing any new logic at the moment.

### Documentation

Adding a new field for pointing to the Atom link of the documentation set of the Pod. Something like:

s.documentation = 'http://zwaldowski.github.com/BlocksKit/com.dizzytechnology.BlocksKit.atom

Then in the future it would be nice if `pod install` would add the documentation set to Xcode according to an user preference. appledoc adds the local documentation by compying it and running the following script:

tell application "Xcode"
load documentation set with path #path#
end tell

I guess that the script could be easily modified to add the atom link.

### Licensing

Currently the podspec only specifies the kind of licence. It would be also nice to have a pointer to the license file itself. For example:

s.licensetext = 'LICENSE'

In some cases like the ( facebook-ios-sdk)[https://github.com/facebook/facebook-ios-sdk] application a single license file is not provided. In that case it could be useful to specify the lines of a file containing the license. Something like:

s.licensetext = 'src / FBConnect.h[1..15]'