Prepare for 1.0

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twitter (1.0.0.rc.2)
+    twitter (1.0.0.rc.3)
       addressable (~> 2.2.2)
       faraday (~> 0.5.1)
       faraday_middleware (~> 0.2.1)

HISTORY.rdoc

@@ -1,9 +1,10 @@
-=== 1.0.0.rc.3 - COMING SOON
+=== 1.0.0.rc.3 - October 27, 2010
 * {Make <tt>#suggestions</tt> method consistent with Twitter API documentation}[http://github.com/jnunemaker/twitter/commit/8393a06a9e8ca03be9adffdbfd042c176e2f6597]
 * {Rename default user agent}[http://github.com/jnunemaker/twitter/commit/2929e533f441bea2313882c4e0ed5593fe999491]
 * {Make all global settings overrideable at the class level}[http://github.com/jnunemaker/twitter/commit/66f3ac223d6f0822c8b3acd4cdcd8c84c8dacfe0]
 * {Expose a property in EnhanceYourCalm for HTTP header "Retry-After"}[http://github.com/jnunemaker/twitter/commit/7ab91f9d26351f52d3c803bb191d33bdacff5094] (@duylam[http://twitter.com/#!/duylam])
 * {Merge <tt>Base</tt>, <tt>Geo</tt>, <tt>Trends</tt>, and <tt>Unauthenticated</tt> into <tt>Client</tt> class}[http://github.com/jnunemaker/twitter/commit/eb53872249634ee1f0179982b091a1a0fd9c0973] (@laserlemon[http://twitter.com/#!/laserlemon])
+* {Move examples into README}[http://github.com/laserlemon/twitter/commit/96600cb5611965788c41b3788668188d37e16803]
 * Rewrite tests as specs
 
 === 1.0.0.rc.2 - October 15, 2010

README.rdoc

@@ -1,6 +1,32 @@
-= The twitter Ruby gem
+= The Twitter Ruby Gem
 ==== A Ruby wrapper for the Twitter REST and Search APIs
-== Examples
+== What's New in 1.0
+This gem has been completely rewritten for version 1.0 thanks to {contributions from numerous 
+people}[http://github.com/jnunemaker/twitter/blob/master/HISTORY.rdoc]. This rewrite breaks 
+compatibility with version 0.9.12 and earlier versions of the gem. Most notably, the 
+<tt>Twitter::Base</tt>, <tt>Twitter:Geo</tt>, <tt>Twitter::LocalTrends</tt>, and <tt>Twitter::Trends</tt> classes have all been 
+combined in the <tt>Twitter::Client</tt> class. This gem will {display deprecation warnings and forward 
+method calls to the Client class}[http://github.com/jnunemaker/twitter/commit/192e5884f367750dbdca8471aa12385ed5b057ca]
+whenever possible. In a handful of cases, method names were changed to improve clarity, consistency, 
+or resolve namespace conflicts.
+
+The <tt>Twitter::Search</tt> class has remained largely the same, however it no longer accepts a query in
+its constructor. You can specify a query using the <tt>containing</tt> method, which is aliased to <tt>q</tt>.
+
+  # Pre-1.0
+  Twitter::Search.new('query')
+  # Post-1.0
+  Twitter::Search.new.q('query')
+
+The public APIs defined in version 1.0 of this gem will maintain backwards compatibility until
+the next major version, following the best practice of {Semantic Versioning}[http://semver.org/].
+You are free to continue using the 0.9 series of the gem, however it will not be maintained, so
+upgrading to 1.0 is strongly recommended.
+
+For more information, please see the full documentation and examples of the gem's usage below.
+== Documentation
+=== http://rdoc.info/github/jnunemaker/twitter
+== Usage Examples
   require 'rubygems'
   require 'twitter'
 
@@ -14,7 +40,7 @@
   puts Twitter.status(27558893223).text
 
   # Initialize a Twitter search
-  search = Twitter::Search.new(:endpoint => "http://search.twitter.com/")
+  search = Twitter::Search.new
 
   # Find the 3 most recent marriage proposals to @justinbieber
   search.containing('marry me').to('justinbieber').result_type('recent').per_page(3).each do |r|
@@ -56,23 +82,20 @@
 
   # Get your rate limit status
   puts client.rate_limit_status.remaining_hits.to_s + " Twitter API request(s) remaining this hour"
-== Documentation
-=== http://rdoc.info/github/jnunemaker/twitter
 == Submitting an Issue
 We use GitHub to track for bugs and features. Before submitting a bug report or feature request,
 check to make sure it hasn't already been submitted. You can indicate support for an existing
 issuse by voting for it. When submitting a bug report, please include a Gist[http://gist.github.com/]
 that includes a stack trace and any details that may be necessary to reproduce the bug, including
 your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull
 request with failing specs.
-
 === http://github.com/jnunemaker/twitter/issues
 == Submitting a Pull Request
 1. Fork the project.
 2. Create a topic branch.
 3. Commit your feature or bug fix.
-4. Add specs for your feature or bug fix. This is important so it doesn't break in the future.
-5. Run `bundle exec rake spec:rcov`. If your changes are not 100% covered, go back to step 4.
+4. Add specs for your feature or bug fix.
+5. Run <tt>bundle exec rake spec:rcov</tt>. If your changes are not 100% covered, go back to step 4.
 6. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
 == Copyright
 Copyright (c) 2010 John Nunemaker, Wynn Netherland, Erik Michaels-Ober, Steve Richert. See LICENSE for details.

lib/twitter/version.rb

@@ -1,3 +1,3 @@
 module Twitter
-  VERSION = '1.0.0.rc.2' unless defined?(Twitter::VERSION)
+  VERSION = '1.0.0.rc.3' unless defined?(Twitter::VERSION)
 end