Skip to content


Subversion checkout URL

You can clone with
Download ZIP


Update README #2

merged 2 commits into from

1 participant


No description provided.

@vtourraine vtourraine merged commit 3601ef6 into master

1 check passed

Details default The Travis build passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
Showing with 9 additions and 1 deletion.
  1. +9 −1
@@ -1,4 +1,5 @@
# SZNAltmetric
**Objective-C client for the Altmetric API.**
[![Build Status](](
@@ -7,6 +8,12 @@
SZNAltmetric is an [Altmetric API]( client for iOS and Mac OS X. It’s built on top of [AFNetworking]( to deal with network operations.
+## Getting Started
+The easiest way to get started is to use [CocoaPods]( 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](
## 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](
+- [Getting Started](
## Requirements
-SZNAltmetric requires Xcode 4.4 with either the iOS 5.0 or Mac OS X 10.7, as well as [AFNetworking](
+SZNAltmetric requires Xcode 4.4 with either the iOS 5.0 or Mac OS X 10.7, as well as [AFNetworking]( Both SZNAltmetric and AFNetworking use [ARC](
## Credits
Something went wrong with that request. Please try again.