README.md in animoto-0.0.0.alpha9 vs README.md in animoto-0.1.0.beta0

- old
+ new

@@ -29,10 +29,23 @@ This document does not cover the details of the Animoto API itself. For such information please see the [Animoto API documentation][api_docs] <a name="getting_started_using_the_ruby_client"></a> ## Getting Started using the Ruby Client +### Installation + +You can install the Animoto API Ruby Client either through [RubyGems](http://rubygems.org): + + gem install animoto -v 0.1.0.alpha0 --pre + +Or by cloning [the repository](http://github.com/animoto/animoto_api_client_ruby) on [GitHub](http://github.com/) and building it from source: + + git clone git://github.com/animoto/animoto_api_client_ruby.git + cd animoto_api_client_ruby + gem build animoto.gemspec + gem install animoto-0.1.0.alpha0.gem + ### Prerequisites #### Readers of this document should be familiar with... * The [the Ruby language](http://ruby-lang.org) @@ -85,26 +98,26 @@ client = Client.new("application_key", "secret") # create a directing and rendering manifest with the video title and # producer. Also include rendering parameters like resolution, framerate, # and format. - manifest = DirectingAndRenderingManifest.new( + manifest = Manifests::DirectingAndRendering.new( :title => "Amazing Title!", :producer => "Fishy Joe", :resolution => "720p", :framerate => 24, :format => 'h264' ) # Add some images, text, and footage to our manifest. - manifest << Image.new("http://website.com/picture.png") - manifest << Image.new("http://website.com/hooray.png", :spotlit => true) - manifest << TitleCard.new("Woohoo!", "Hooray for everything!") - manifest << Footage.new("http://website.com/movie.mp4", :duration => 3.5) + manifest << Assets::Image.new("http://website.com/picture.png") + manifest << Assets::Image.new("http://website.com/hooray.png", :spotlit => true) + manifest << Assets::TitleCard.new("Woohoo!", "Hooray for everything!") + manifest << Assets::Footage.new("http://website.com/movie.mp4", :duration => 3.5) # Setup the soundtrack. - manifest << Song.new("http://website.com/song.mp3", :artist => "Fishy Joe") + manifest << Assets::Song.new("http://website.com/song.mp3", :artist => "Fishy Joe") # Setup to get http callbacks for status notification (see below for # polling example). manifest.http_callback_url = "http://mysite.com/animoto_callback" manifest.http_callback_format = "json" @@ -126,20 +139,20 @@ # Create a new client using our application key and secret client = Client.new("application_key", "secret") # Create a directing manifest. The directing manifest controls the images # and other visual elements that will be in our final video. - manifest = DirectingManifest.new(:title => "Amazing Title!") + manifest = Manifests::Directing.new(:title => "Amazing Title!") # Add some images, text, and footage to our manifest. - manifest << Image.new("http://website.com/picture.png") - manifest << Image.new("http://website.com/hooray.png", :spotlit => true) - manifest << TitleCard.new("Woohoo!", "Hooray for everything!") - manifest << Footage.new("http://website.com/movie.mp4", :duration => 3.5) + manifest << Assets::Image.new("http://website.com/picture.png") + manifest << Assets::Image.new("http://website.com/hooray.png", :spotlit => true) + manifest << Assets::TitleCard.new("Woohoo!", "Hooray for everything!") + manifest << Assets::Footage.new("http://website.com/movie.mp4", :duration => 3.5) # Setup the soundtrack. - manifest << Song.new("http://website.com/song.mp3") + manifest << Assets::Song.new("http://website.com/song.mp3") # Request a new directing job by sending the API our directing manifest. directing_job = client.direct!(manifest) # Poll the service until the directing job is done. @@ -152,10 +165,10 @@ # associated with this job. if storyboard = directing_job.storyboard # Now it's time to render the storyboard into a video. First we create # a rendering manifest. - manifest = RenderingManifest.new(storyboard, :resolution => "720p", :framerate => 24, :format => 'h264') + manifest = Manifests::Rendering.new(storyboard, :resolution => "720p", :framerate => 24, :format => 'h264') # Send the manifest to the API. rendering_job = client.render!(manifest) # Poll the service until the rendering job is done