sjs/instapaper
1
0
Fork 0
mirror of https://github.com/samsonjs/instapaper.git synced 2026-04-27 14:57:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme edits for 1.0.0

Browse source
This commit is contained in:
stve 2015-02-28 18:25:56 -05:00
parent 95a2ad91b1
commit 8733b43acb
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -21,10 +21,8 @@ If you've used earlier versions of this library, a lot has changed in version `1
* swapped out Faraday for http.rb * swapped out Faraday for http.rb
* responses now return custom classes instead of Hashie::Rash objects * responses now return custom classes instead of Hashie::Rash objects
* most API methods are more clear as to their behavior (i.e., `#star_bookmark` instead of just `#star`) * most API methods are more clear as to their behavior (i.e., `#star_bookmark` instead of just `#star`)
* module-based configuration ane invocation has been removed, you'll now need to instantiate an `Instapaper::Client` instead (see usage below) * module-based configuration and invocation has been removed, you'll now need to instantiate an `Instapaper::Client` instead (see usage below)
* Improved error handling
Also new in `1.x`
* Updates for version 1.1 of Instapaper's API * Updates for version 1.1 of Instapaper's API
* Support for Highlights API * Support for Highlights API
@ -58,7 +56,7 @@ client.verify_credentials
Retrieve a list of bookmarks: Retrieve a list of bookmarks:
```ruby ```ruby
clientclient.bookmarks client.bookmarks
``` ```
Add a new bookmark: Add a new bookmark:
@ -142,7 +140,7 @@ client.set_order(['folder_id1:2','folder_id2:1'])
* Make your feature addition or bug fix. * Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a * Add tests for it. This is important so I don't break it in a
future version unintentionally. future version unintentionally.
* Commit, do not mess with rakefile, version, or history. * Commit, do not mess with Rakefile, gem version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches. * Send me a pull request. Bonus points for topic branches.