Permalink
Browse files

Reformat README

  • Loading branch information...
1 parent 70e3cc5 commit 44c19ca08db28c7063bc51869e5793b5b8009753 Tobias Matthies committed Sep 21, 2010
Showing with 17 additions and 5 deletions.
  1. +17 −5 README.rdoc
View
@@ -9,23 +9,35 @@ API wrapper for the Live Labs zoom.it API
== Usage
require 'zoomit'
+
@zoomit = Zoomit::Content.create('http://www.example.org')
- => <#Zoomit::Response dzi=<#Zoomit::Response height=840 tileFormat="png" tileOverlap=1 tileSize=254 url="http://cache.zoom.it/content/7nA.dzi" width=1024> embedHtml="<script src=\"http://zoom.it/7nA.js?width=auto&height=400px\"></script>" failed=false id="7nA" progress=1 ready=true shareUrl="http://zoom.it/7nA" url="http://www.mit2m.de/">
+ => <#Zoomit::Response dzi=<#Zoomit::Response height=840 tileFormat="png" tileOverlap=1 tileSize=254
+ url="http://cache.zoom.it/content/7nA.dzi" width=1024>
+ embedHtml="<script src=\"http://zoom.it/7nA.js?width=auto&height=400px\"></script>" failed=false id="7nA"
+ progress=1 ready=true shareUrl="http://zoom.it/7nA" url="http://www.mit2m.de/">
+
@zoomit.shareURL
=> "http://zoom.it/7nA"
+
@zoomit.dzi.tileFormat
=> "png"
To search for zoom.it content by id, use Zoomit::Content.find(id)
@zoomit = Zoomit::Content.find('7nA')
- => <#Zoomit::Response dzi=<#Zoomit::Response height=840 tileFormat="png" tileOverlap=1 tileSize=254 url="http://cache.zoom.it/content/7nA.dzi" width=1024> embedHtml="<script src=\"http://zoom.it/7nA.js?width=auto&height=400px\"></script>" failed=false id="7nA" progress=1 ready=true shareUrl="http://zoom.it/7nA" url="http://www.mit2m.de/">
-
+ => <#Zoomit::Response dzi=<#Zoomit::Response height=840 tileFormat="png" tileOverlap=1 tileSize=254
+ url="http://cache.zoom.it/content/7nA.dzi" width=1024>
+ embedHtml="<script src=\"http://zoom.it/7nA.js?width=auto&height=400px\"></script>" failed=false id="7nA"
+ progress=1 ready=true shareUrl="http://zoom.it/7nA" url="http://www.mit2m.de/">
+
To search by url use Zoomit::Content.find_by_url(url)
@zoomit = Zoomit::Content.find_by_url('http://www.mit2m.de')
- => <#Zoomit::Response dzi=<#Zoomit::Response height=840 tileFormat="png" tileOverlap=1 tileSize=254 url="http://cache.zoom.it/content/7nA.dzi" width=1024> embedHtml="<script src=\"http://zoom.it/7nA.js?width=auto&height=400px\"></script>" failed=false id="7nA" progress=1 ready=true shareUrl="http://zoom.it/7nA" url="http://www.mit2m.de/">
-
+ => <#Zoomit::Response dzi=<#Zoomit::Response height=840 tileFormat="png" tileOverlap=1 tileSize=254
+ url="http://cache.zoom.it/content/7nA.dzi" width=1024>
+ embedHtml="<script src=\"http://zoom.it/7nA.js?width=auto&height=400px\"></script>" failed=false id="7nA"
+ progress=1 ready=true shareUrl="http://zoom.it/7nA" url="http://www.mit2m.de/">
+
== Todo
* Rubyfy response hash keys

0 comments on commit 44c19ca

Please sign in to comment.