Skip to content

Commit f0da9d7

Browse files
committed
Updated README with the Instapaper demo
1 parent e69989c commit f0da9d7

File tree

2 files changed

+32
-4
lines changed

2 files changed

+32
-4
lines changed

README.md

+32-4
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ A common OAuth flow using **RSOAuthEngine** should go like this:
2626
8. Fill the access token using `fillTokenWithResponseBody:type` (use `RSOAuthAccessToken` as type).
2727
9. From now on, all requests sent with `enqueueSignedOperation` will be signed with your tokens.
2828

29-
Alternatively you could use `setAccessToken:secret` after initialization to define a previously stored access token.
29+
Alternatively you could use `setAccessToken:secret` after initialization to define a previously stored access token. If you need or want to use xAuth instead of the request token/authorize workflow, please take a look at the Instapaper demo.
3030

31-
## Demo
31+
## Twitter Demo
3232

3333
<table>
3434
<tr>
@@ -38,7 +38,7 @@ Alternatively you could use `setAccessToken:secret` after initialization to defi
3838
<td valign="top">
3939
<h3>About</h3>
4040

41-
<p><strong>RSOAuthEngine</strong> comes with a sample project that demonstrates how to use it to authenticate with Twitter. It includes a basic Twitter engine that implements Twitter's OAuth authentication flow and allows you to post a tweet. It also shows you how to persist the OAuth access token in the Keychain. The Twitter engine should not be considered production code, and is only included to demonstrate <strong>RSOAuthEngine</strong>.</p>
41+
<p>This sample project demonstrates how to use <strong>RSOAuthEngine</strong> to authenticate with Twitter. It includes a basic engine that implements Twitter's OAuth authentication flow and allows you to post a tweet. It also shows you how to persist the OAuth access token in the Keychain. The Twitter engine should not be considered production code, and is only included to demonstrate <strong>RSOAuthEngine</strong>.</p>
4242

4343
<h3>Building</h3>
4444

@@ -56,9 +56,37 @@ Alternatively you could use `setAccessToken:secret` after initialization to defi
5656
</tr>
5757
</table>
5858

59+
## Instapaper Demo
60+
61+
<table>
62+
<tr>
63+
<td width="300">
64+
<img src="https://github.com/rsieiro/RSOAuthEngine/raw/master/screenshot-2.png" alt="Screenshot" width="396" />
65+
</td>
66+
<td valign="top">
67+
<h3>About</h3>
68+
69+
<p>This sample project demonstrates how to use <strong>RSOAuthEngine</strong> with xAuth to authenticate with Instapaper. It includes a basic engine that implements Instapapers's xAuth authentication flow and allows you to add a bookmark to your account. It also shows you how to persist the OAuth access token in the Keychain. The Instapaper engine should not be considered production code, and is only included to demonstrate <strong>RSOAuthEngine</strong>.</p>
70+
71+
<h3>Building</h3>
72+
73+
<p>To build the demo project, follow these steps:</p>
74+
75+
<ol>
76+
<li>In the project directory, run <code>git submodule update --init</code> to retrieve MKNetworkKit (added to the project as a submodule).</li>
77+
<li>Put your consumer key and secret at the top of <code>RSInstapaperEngine.m</code> and remove the <code>#error</code> macro. If you don't have a consumer key/secret, register an app at <a href="http://www.instapaper.com/main/request_oauth_consumer_token">this page</a> to get a pair. <strong>Important</strong>: most Instapaper API methods are only available to users with a Subscription account.</li>
78+
</ol>
79+
80+
<h3>Tips</h3>
81+
82+
<p>Swipe from left to right in the status message to clear previously stored OAuth tokens.</p>
83+
</td>
84+
</tr>
85+
</table>
86+
5987
## Compatibility
6088

61-
Currently this engine has only been tested with Twitter. If you use **RSOAuthEngine** to implement OAuth authentication with another service, please let me know so I can update this session.
89+
Currently this engine has been tested with Twitter and Instapaper. If you use **RSOAuthEngine** to implement OAuth authentication with another service, please let me know so I can update this session.
6290

6391
## License
6492

screenshot-2.png

167 KB
Loading

0 commit comments

Comments
 (0)