Updated README and test documentation

ealdent · Aug 31, 2010 · c24290c · c24290c
1 parent af49d34
commit c24290c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/README.rdoc b/README.rdoc
@@ -7,6 +7,10 @@ Wordnik wants to be a place for all the words, and everything known about them.
 Install gem via gemcutter.
 
   gem install wordnik
+
+== Usage
+
+For a summary of implemented methods, check out {rdoc.info/github/ealdent/wordnik}[http://rdoc.info/github/ealdent/wordnik/master/Wordnik] or simply peek inside lib/wordnik.rb
 
 == Note on Patches/Pull Requests
 
@@ -20,4 +24,4 @@ Install gem via gemcutter.
 
 == Copyright
 
-Copyright (c) 2009 Jason Adams under the BSD license. See LICENSE for details.
+Copyright (c) 2009-2010 Jason Adams under the BSD license. See LICENSE for details.
diff --git a/test/test_wordnik.rb b/test/test_wordnik.rb
@@ -1,7 +1,7 @@
 require 'helper'
 
-#  In order to run any tests, you must copy your API key into a file in the
-#  same directory that you run your tests from, or else set the environment
+#  In order to run any tests, you must copy your API key into a file named .api-key 
+#  in the same directory that you run your tests from, or else set the environment
 #  variable WORDNIK_API_KEY to the api key you wish to use.
 class TestWordnik < Test::Unit::TestCase
   context "initializing a Wordnik object" do