Provide proper README

Author: jure

README.md

@@ -1,6 +1,6 @@
 # PaperMetadata
 
-TODO: Write a gem description
+PaperMetadata is a gem that gets a publication's metadata from by accessing the CrossRef OpenURL API.
 
 ## Installation
 
@@ -18,7 +18,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You must first configure PaperMetadata with your CrossRef API username (which you can obtain here ![http://www.crossref.org/requestaccount/](http://www.crossref.org/requestaccount/)):
+
+    PaperMetadata.doi_username = '[email protected]'
+
+You can then access API:
+
+    result = PaperMetadata.metadata_for('doi:10.1021/ac1014832')
+
+The result will be a hash similar to this one:
+
+    { :volume=>"82",
+      :isssue=>"19",
+      :first_page=>"8153",
+      :last_page=>"8160",
+      :title=>
+      "Basic Modeling Approach To Optimize Elemental Imaging by Laser Ablation ICPMS",
+      :authors=>"Jure Triglav, Johannes T. van Elteren, Vid S. Šelih",
+      :journal=>"Anal. Chem. 2010",
+      :resource=>"http://pubs.acs.org/doi/abs/10.1021/ac1014832" }
 
 ## Contributing
 
@@ -27,3 +45,5 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Be sure to run the specs too.

test/test_paper_metadata.rb

@@ -10,6 +10,7 @@ def test_doi_parsing
       to_return(:body => doi_response, :status => 200,  :headers => { 'Content-Length' => doi_response.length } )
 
     PaperMetadata.doi_username = '[email protected]'
+
     assert_equal "Basic Modeling Approach To Optimize Elemental Imaging by Laser Ablation ICPMS",
       PaperMetadata.metadata_for('doi:10.1021/ac1014832')[:title]
   end