From 3334c4c13441de76cdb02a819ca29cd71e763caa Mon Sep 17 00:00:00 2001 From: Ry Walker <4283+ryw@users.noreply.github.com> Date: Sat, 31 Dec 2022 16:46:25 -0500 Subject: [PATCH] Cleanup README format --- README.md | 55 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 3ad108c..c418d76 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ A Ruby wrapper for the [Pinboard API](http://pinboard.in/api/). Installation ------------ - gem install pinboard + +`gem install pinboard` Examples -------- @@ -12,8 +13,8 @@ Examples I'm currently exploring two API interfaces: ```ruby - pinboard = Pinboard::Client.new(:token => 'your_api_token') - posts = pinboard.posts +pinboard = Pinboard::Client.new(:token => 'your_api_token') +posts = pinboard.posts ``` Your [API token](https://blog.pinboard.in/2012/07/api_authentication_tokens/) can be found on your @@ -22,44 +23,43 @@ Your [API token](https://blog.pinboard.in/2012/07/api_authentication_tokens/) ca or: ```ruby - posts = Pinboard::Post.all(:username => 'foo', :password => 'bar') +posts = Pinboard::Post.all(:username => 'foo', :password => 'bar') ``` Both examples work. Passing arguments: (works only for the Client API Interface) ```ruby - pinboard.posts(:tag => 'ruby') #all posts tagged 'ruby' - pinboard.posts(:tag => 'ruby,pinboard') #all posts tagged 'ruby' and 'pinboard' - pinboard.posts(:start => 20) #starting on the 20th post - pinboard.posts(:results => 20) #return only first 20 matching posts - pinboard.posts(:fromdt => 4.days.ago) #all posts in past 4 days - pinboard.posts(:todt => 4.days.ago) #all posts up to 4 days ago +pinboard.posts(:tag => 'ruby') #all posts tagged 'ruby' +pinboard.posts(:tag => 'ruby,pinboard') #all posts tagged 'ruby' and 'pinboard' +pinboard.posts(:start => 20) #starting on the 20th post +pinboard.posts(:results => 20) #return only first 20 matching posts +pinboard.posts(:fromdt => 4.days.ago) #all posts in past 4 days +pinboard.posts(:todt => 4.days.ago) #all posts up to 4 days ago ``` Adding new posts: ```ruby - pinboard.add(:url => "http://example.com/", :description => 'Example post') +pinboard.add(:url => "http://example.com/", :description => 'Example post') ``` - Future Examples (I don't need them, so I haven't written them) -------------------------------------------------------------- - pinboard.posts(:meta => true) #include meta data in post models +`pinboard.posts(:meta => true) #include meta data in post models` Ruby Support & Continuous Integration ------------------------------------- I am using [travis-ci.org](http://travis-ci.org) for continuous integration and support of the following rubies in rvm: - * 1.9.3 - * 2.0.0 - * 2.1 - * 2.2 - * jruby - * ruby-head +* 1.9.3 +* 2.0.0 +* 2.1 +* 2.2 +* jruby +* ruby-head [![Build Status](https://secure.travis-ci.org/ryw/pinboard.png)](http://travis-ci.org/ryw/pinboard) @@ -67,22 +67,23 @@ integration and support of the following rubies in rvm: Links ----- - * [Pinboard API Documentation](http://pinboard.in/api/) + +* [Pinboard API Documentation](http://pinboard.in/api/) How to Contribute ----------------- If you find what looks like a bug: - * Check the [GitHub issue tracker](http://github.com/ryw/pinboard/issues/) - to see if anyone else has had the same issue. - * If you don’t see anything, create an issue with information on how to reproduce it. +* Check the [GitHub issue tracker](http://github.com/ryw/pinboard/issues/) + to see if anyone else has had the same issue. +* If you don’t see anything, create an issue with information on how to reproduce it. If you want to contribute an enhancement or a fix: - * Fork the [project on github](http://github.com/ryw/pinboard). - * Make your changes with specs. - * Commit the changes without messing with the Rakefile, VERSION, or history. - * Send me a pull request. +* Fork the [project on github](http://github.com/ryw/pinboard). +* Make your changes with specs. +* Commit the changes without messing with the Rakefile, VERSION, or history. +* Send me a pull request. TODO ----