Permalink
Browse files

Merge pull request #2 from shazino/development

Update README
  • Loading branch information...
2 parents 967e0fa + 63e878f commit 3601ef6be88523c48f01d29839504e5c04a7f453 @vtourraine vtourraine committed Apr 9, 2013
Showing with 9 additions and 1 deletion.
  1. +9 −1 README.md
View
@@ -1,4 +1,5 @@
# SZNAltmetric
+
**Objective-C client for the Altmetric API.**
[![Build Status](https://travis-ci.org/shazino/SZNAltmetric.png?branch=master)](https://travis-ci.org/shazino/SZNAltmetric)
@@ -7,6 +8,12 @@
SZNAltmetric is an [Altmetric API](http://api.altmetric.com) client for iOS and Mac OS X. It’s built on top of [AFNetworking](http://www.github.com/AFNetworking/AFNetworking) to deal with network operations.
+## Getting Started
+
+The easiest way to get started is to use [CocoaPods](http://cocoapods.org) to manage your dependencies. Follow the instructions on the CocoaPods site to install the gem, and specify SZNAltmetric as a dependency in your `Podfile` with `pod 'SZNAltmetric', '0.2'`.
+
+If you want to install SZNAltmetric manually, you can read our [“Getting Started” guide](https://github.com/shazino/SZNAltmetric/wiki/Getting-Started).
+
## Example Usage
We wanted to make it as simple as possible to fetch details about an article from the API, so here is how it looks like:
@@ -30,10 +37,11 @@ As you can see, we have just requested an article based on its DOI (you can also
## References
- [Changelog](https://github.com/shazino/SZNAltmetric/wiki/Changelog)
+- [Getting Started](https://github.com/shazino/SZNAltmetric/wiki/Getting-Started)
## Requirements
-SZNAltmetric requires Xcode 4.4 with either the iOS 5.0 or Mac OS X 10.7, as well as [AFNetworking](https://github.com/AFNetworking/AFNetworking).
+SZNAltmetric requires Xcode 4.4 with either the iOS 5.0 or Mac OS X 10.7, as well as [AFNetworking](https://github.com/AFNetworking/AFNetworking). Both SZNAltmetric and AFNetworking use [ARC](https://developer.apple.com/library/ios/#releasenotes/ObjectiveC/RN-TransitioningToARC/Introduction/Introduction.html).
## Credits

0 comments on commit 3601ef6

Please sign in to comment.