README.md in wayback-0.1.0 vs README.md in wayback-0.2.0
- old
+ new
@@ -1,32 +1,46 @@
# Wayback Gem
-
-
+[][gem]
+[][travis]
+[][coveralls]
+[gem]: https://rubygems.org/gems/wayback
+[travis]: http://travis-ci.org/XOlator/wayback_gem
+[coveralls]: https://coveralls.io/r/XOlator/wayback_gem
+
+
A Ruby interface to Archive.org's Wayback Machine Memento API.
## Installation
gem install wayback
## Quick Start Guide
-So you want to get up and tweeting as fast as possible?
+Accessing the Wayback Machine is super-duper easy.
+```ruby
+require 'wayback'
+Wayback.page('http://www.xolator.com', :first)
+```
+
## Documentation
-COMING SOON! -- [documentation](http://rdoc.info/gems/wayback)
+You can browse the Rdoc [here][documentation].
+[documentation]: http://rdoc.info/github/XOlator/wayback_gem/master/frames
+
## Configuration
-There is no real configuration necessary for accessing Archive.org's Wayback Machine Memento API, however you can change endpoint and other basic connection options.
+There is no real configuration necessary for accessing the Wayback Machine Memento API, however you can change endpoint and other basic connection options.
-The current defaults for this gem are:
+The current defaults configurations for this gem are:
```ruby
Wayback.configure do |c|
- c.endpoint = 'http://api.wayback.archive.org'
+ c.endpoint = 'http://web.archive.org'
+ c.endpoint_path = '/web'
c.connection_options = {
:headers => {:user_agent => "Wayback Ruby Gem #{Wayback::Version}"},
:request => {:open_timeout => 5, :timeout => 10},
:ssl => {:verify => false},
}
@@ -66,16 +80,19 @@
Wayback.page('http://www.xolator.com', :last)
```
## Additional Notes
-Based heavily on the [Twitter gem](https://www.github.com/sferik/twitter). (Xie xie!)
+Based heavily on the [Twitter gem][twitter_gem]. (Xièxie!)
-More information on Archive's Wayback Machine memento API can be found [here](http://mementoweb.org/depot/native/ia/).
+More information on Archive's Wayback Machine memento API can be found [here][wayback_api].
+[twitter_gem]: https://www.github.com/sferik/twitter
+[wayback_api]: http://mementoweb.org/depot/native/ia/
## Copyright
-Copyright (c) 2013 XOlator.
-See [LICENSE][] for details.
+Copyright (c) 2013 [XOlator][xolator].
+See [LICENSE][license] for details.
+[xolator]: http://www.xolator.com
[license]: LICENSE.md