Skip to content

Commit

Permalink
Updated README/Rdoc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
ariejan committed Nov 30, 2011
1 parent 1799db3 commit 1a1df03
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 30 deletions.
52 changes: 22 additions & 30 deletions README.rdoc
@@ -1,72 +1,64 @@
= imdb

Allows you to search and inspect movies from IMDB.com.
home :: http://github.com/ariejan/imdb
rdoc :: http://ariejan.github.com/imdb/
bugs :: http://github.com/ariejan/imdb/issues

The code, issue tracker and wiki can be found at: http://github.com/ariejan/imdb
== Description

API documentation is available at http://ariejan.github.com/imdb/
This gem allows you to easy access publicly available data from IMDB.

== DESCRIPTION:

This packages allows you to easy access publicly available data from IMDB.

== FEATURES/PROBLEMS:
== Features

IMDB currently features the following:

* Querying details movie info
* Searching for movies
* Command-line utility included.

== SYNOPSIS:
== Synopsis

Movies:

i = Imdb::Movie.new("0095016")

i.title
#=> "Die Hard"
i.cast_members.first
#=> "Bruce Willis"
i = Imdb::Movie.new("0095016")
i.title
#=> "Die Hard"
i.cast_members.first
#=> "Bruce Willis"

Searching:

i = Imdb::Search.new("Star Trek")

i.movies.size
#=> 97

Using the command line utility is quite easy:

$ imdb Star Trek

or to get movie info

$ imdb 0095016

== REQUIREMENTS:

All required gems are installed automagically through RubyGems.

* Hpricot 0.8.1

== INSTALL:
== Installation

$ sudo gem install imdb -s http://gemcutter.org
$ gem install imdb

== DOCUMENTATION:
== Documentation

This README and generated RDoc documentation are available from http://ariejan.github.com/imdb/

== TESTING:
== Running tests

You'll need rspec and fakeweb installed to run the specs. Y
You'll need rspec and fakeweb installed to run the specs.

$ bundle install
$ bundle exec rake spec

Although not recommended, you may run the specs against the live imdb.com
website. This will make a lot of calls to imdb.com, use it wisely.
website. This will make a lot of calls to imdb.com, use it wisely.

$ LIVE_TEST=true bundle exec rake spec

Expand All @@ -75,7 +67,7 @@ fixtures:refresh rake task

$ bundle exec rake fixtures:refresh

== LICENSE:
== License

(The MIT License)

Expand Down
1 change: 1 addition & 0 deletions Rakefile
Expand Up @@ -20,6 +20,7 @@ task :default => :spec
require 'imdb/version'
require 'rdoc/task'
RDoc::Task.new(:rdoc) do |rdoc|
rdoc.main = 'README.rdoc'
rdoc.rdoc_dir = 'rdoc'
rdoc.title = "imdb #{Imdb::VERSION} documentation"
rdoc.rdoc_files.include('README*')
Expand Down

0 comments on commit 1a1df03

Please sign in to comment.