sjs/instapaper
1
0
Fork 0
mirror of https://github.com/samsonjs/instapaper.git synced 2026-03-25 08:55:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme updates

Browse source
This commit is contained in:
Steve Agalloco 2011-12-01 23:36:06 -05:00
parent f6db859a53
commit 3d1fd75922
1 changed files with 25 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -9,12 +9,34 @@ Installation
Usage
-----
Instapaper offers full support for all methods exposed through the Full API.
Instapaper offers full support for all methods exposed through the Full API. Note that Instapaer does not support the request-token/authorize workflow. To obtain an access token, use the `access_token` method.
Configuration
-------------
```ruby
Instapaper.configure do |config|
config.consumer_key = YOUR_CONSUMER_KEY
config.consumer_secret = YOUR_CONSUMER_SECRET
config.oauth_token = YOUR_OAUTH_TOKEN
config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
end
```
Authentication
--------------
To obtain an access token via xAuth:
```ruby
Instapaper.access_token(username, password)
```
You can also verify credentials once you have received tokens:
```ruby
Instapaper.verify_credentials
```
Bookmark Operations
-------------------
@ -90,22 +112,10 @@ And remove folders by referencing a folder by it's id.
Instapaper.delete_folder(folder_id)
```
Lastly, the folders can be reordered by
Other Operations
----------------
To obtain an access token via xAuth:
Lastly, the folders can be reordered:
```ruby
Instapaper.access_token(username, password)
```
You can also verify credentials once you have received tokens:
```ruby
Instapaper.verify_credentials
Instapaper.set_order(['folder_id1:2','folder_id2:1'])
```
Restrictions