Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Version 0.1.2

* Added Rakefile for generating documentation
* Added documentation installation instructions to readme
  • Loading branch information...
commit 752c8d718b10aa97cc4047bfd84ff4ff5981992d 1 parent bdb9409
@soffes soffes authored
Showing with 58 additions and 2 deletions.
  1. +1 −0  .gitignore
  2. +4 −2 Changelog.markdown
  3. +38 −0 Rakefile
  4. +15 −0 Readme.markdown
View
1  .gitignore
@@ -4,3 +4,4 @@
*.perspectivev3
*.xcworkspace
xcuserdata
+Documentation
View
6 Changelog.markdown
@@ -1,13 +1,15 @@
# SSKeychain Changelog
-### Version 0.1.1
+### Version 0.1.2
-**Unreleased**
+[Released October 18, 2011](https://github.com/samsoffes/sskeychain/tree/0.1.2)
* Added VERSION file
* Added documentation
* Added string constants for keys in returned dictionaries
* Renamed `SSKeychainErrorDomain` to `kSSKeychainErrorDomain`
+* Added Rakefile for generating documentation
+* Added documentation installation instructions to readme
### Version 0.1.1
View
38 Rakefile
@@ -0,0 +1,38 @@
+header_path = '*.h'
+
+appledoc_options = [
+ '--output Documentation',
+ '--project-name SSKeychain',
+ '--project-company \'Sam Soffes\'',
+ '--company-id com.samsoffes',
+ "--project-version #{`cat VERSION`.strip}",
+ '--keep-intermediate-files',
+ '--create-html',
+ '--templates ~/Library/Application\ Support/appledoc/Templates/',
+ '--no-repeat-first-par',
+ '--verbose']
+
+namespace :docs do
+ desc 'Clean docs'
+ task :clean do
+ `rm -rf Documentation`
+ end
+
+ desc 'Install docs'
+ task :install => [:'docs:clean'] do
+ `appledoc #{appledoc_options.join(' ')} --create-docset --install-docset #{header_path}`
+ end
+
+ desc 'Publish docs'
+ task :publish => [:'docs:clean'] do
+ extra_options = [
+ '--create-docset',
+ '--publish-docset',
+ '--install-docset',
+ '--docset-atom-filename com.samsoffes.keychain.atom',
+ '--docset-feed-url http://docs.samsoff.es/%DOCSETATOMFILENAME',
+ '--docset-package-url http://docs.samsoff.es/%DOCSETPACKAGEFILENAME'
+ ]
+ `appledoc #{appledoc_options.join(' ')} #{extra_options.join(' ')} #{header_path}`
+ end
+end
View
15 Readme.markdown
@@ -23,6 +23,21 @@ SSKeychain has the following class methods for working with the system keychain:
Easy as that. (See [SSKeychain.h](https://github.com/samsoffes/sskeychain/blob/master/SSKeychain.h) for all of the methods.)
+## Documentation
+
+Install the documentation into Xcode with the following steps:
+
+1. Open Xcode Preferences
+2. Choose Downloads
+3. Choose the Documentation tab
+4. Clip the plus button in the bottom right and enter the following URL:
+
+ http://docs.samsoff.es/com.samsoffes.sskeychain.atom
+
+Be sure you have the docset selected in the organizer to see results for SSKeychain.
+
+You can also **read the [SSKeychain Documentation](http://docs.samsoff.es/SSKeychain/Classes/SSKeychain.html) online.**
+
## Debugging
If you saving to the keychain fails, you use the error codes provided in SSKeychain.h. Here's an example:
Please sign in to comment.
Something went wrong with that request. Please try again.