fix readme formatting

This commit is contained in:
Steve Agalloco 2011-12-01 23:09:34 -05:00
parent c34b46b95b
commit f6db859a53

View file

@ -14,65 +14,78 @@ Instapaper offers full support for all methods exposed through the Full API.
Configuration Configuration
------------- -------------
Bookmark Operations
-------------------
Retrieve a list of bookmarks: Retrieve a list of bookmarks:
```ruby ```ruby
Instapaper.bookmarks Instapaper.bookmarks
``` ```
Add a new bookmark: Add a new bookmark:
```ruby ```ruby
Instapaper.add_bookmark('http://someurl.com', :title => 'This is the title', :description => 'This is the description') Instapaper.add_bookmark('http://someurl.com', :title => 'This is the title', :description => 'This is the description')
``` ```
Remove a bookmark: Remove a bookmark:
```ruby ```ruby
Instapaper.delete_bookmark(bookmark_id) Instapaper.delete_bookmark(bookmark_id)
``` ```
Update read progress: Update read progress:
```ruby ```ruby
Instapaper.update_read_progress(bookmark_id, 0.5) Instapaper.update_read_progress(bookmark_id, 0.5)
``` ```
Star/Un-star a bookmark: Star/Un-star a bookmark:
```ruby ```ruby
Instapaper.star(bookmark_id) Instapaper.star(bookmark_id)
Instapaper.unstar(bookmark_id) Instapaper.unstar(bookmark_id)
``` ```
Archive/Un-archive a bookmark: Archive/Un-archive a bookmark:
```ruby ```ruby
Instapaper.archive(bookmark_id) Instapaper.archive(bookmark_id)
Instapaper.unarchive(bookmark_id) Instapaper.unarchive(bookmark_id)
``` ```
Move a bookmark to a folder: Move a bookmark to a folder:
```ruby ```ruby
Instapaper.move(bookmark_id, folder_id) Instapaper.move(bookmark_id, folder_id)
``` ```
Obtain the text of a bookmark: Obtain the text of a bookmark:
```ruby ```ruby
Instapaper.text(bookmark_id) Instapaper.text(bookmark_id)
``` ```
Bookmark Operations
-------------------
Folder Operations Folder Operations
----------------- -----------------
To obtain the list of folders: To obtain the list of folders:
```ruby ```ruby
Instapaper.folders Instapaper.folders
``` ```
You can add by passing a name: You can add by passing a name:
```ruby ```ruby
Instapaper.add_folder('eventmachine') Instapaper.add_folder('eventmachine')
``` ```
And remove folders by referencing a folder by it's id. And remove folders by referencing a folder by it's id.
```ruby ```ruby
Instapaper.delete_folder(folder_id) Instapaper.delete_folder(folder_id)
``` ```
@ -84,11 +97,13 @@ Other Operations
---------------- ----------------
To obtain an access token via xAuth: To obtain an access token via xAuth:
```ruby ```ruby
Instapaper.access_token(username, password) Instapaper.access_token(username, password)
``` ```
You can also verify credentials once you have received tokens: You can also verify credentials once you have received tokens:
```ruby ```ruby
Instapaper.verify_credentials Instapaper.verify_credentials
``` ```
@ -97,6 +112,7 @@ Restrictions
------------ ------------
Users without an Instapaper Subscription may only invoke the following calls: Users without an Instapaper Subscription may only invoke the following calls:
```ruby ```ruby
Instapaper.access_token Instapaper.access_token
Instapaper.verify_credentials Instapaper.verify_credentials