@@ -2,6 +2,29 @@ # API. This is very much a work in progress so don't count on it not changing # (for the better). # +# The MediaWiki class wraps all the functionality for general MediaWiki usage. +# You can also require wikipedia.rb to get the +# Wikipedia[link:/files/lib/wikipedia_rb.html] constant that wraps +# up the basic functionality. +# +# == Installation +# sudo gem install schleyfox-wikipedia-api --source=http://gems.github.com +# +# == Basic Usage +# +# For example, to get a page from Wikiquote +# +# require 'mediawiki' +# w = MediaWiki.new('http://en.wikiquote.org/w/api.php') +# w.find_by_title('Oscar Wilde') +# +# If you want Wikipedia, you can use the built in constant +# +# require 'wikipedia' +# Wikipedia.find_by_title('Oscar Wilde') +# +# == Source +# # Check out the source on github http://github.com/schleyfox/wikipedia-api ['hpricot', 'cgi', 'open-uri'].each {|f| require f} lib/mediawiki.rb 81b2e073606ce5139ee8f05cdb77ebb4404133a2 Ben Hughes ben@pixelmachine.org http://github.com/schleyfox/wikipedia-api/commit/c1f28c146ca00347d73bbe59b15a1052ffdc94ec c1f28c146ca00347d73bbe59b15a1052ffdc94ec 2008-05-09T21:03:56-07:00 2008-05-09T21:03:56-07:00 Updated Docs * yeah, my docs were out of date and I learned that railsenvy was linking 3402a7d35d0e74d0ca7f0343e106d2779024c145 Ben Hughes ben@pixelmachine.org