Browse files

RDoc update

  • Loading branch information...
1 parent eb6d962 commit b56b539bcb3e1ed517b125a4ac6227e499ed5c08 @jonbuda committed Mar 2, 2010
Showing with 6 additions and 5 deletions.
  1. +4 −2 README.rdoc
  2. +1 −2 spec/spec_helper.rb
  3. +1 −1 spec/ymlp_spec.rb
View
6 README.rdoc
@@ -1,6 +1,8 @@
-= ymlp
+= A Simple Ruby library for the YMLP (YourMailingListProvider) API
-Description goes here.
+YMLP is a simple Ruby library for interacting with the API provided by {YourMailingListProvider.com}[http://yourmailinglistprovider.com] enabling you to modifying mailing lists and contacts.
+
+YMLP uses the excellent {HTTParty}[http://github.com/jnunemaker/httparty] gem.
== Note on Patches/Pull Requests
View
3 spec/spec_helper.rb
@@ -17,8 +17,7 @@ def fixture_file(filename)
end
def ymlp_base_url(url = "/")
- url = "https://www.ymlp.com/api#{url}"
- Regexp.new(Regexp.escape(url))
+ Regexp.new(Regexp.escape("https://www.ymlp.com/api#{url}"))
end
def stub_get(url, filename)
View
2 spec/ymlp_spec.rb
@@ -1,7 +1,7 @@
require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
describe "YMLP" do
- before(:each) do
+ before(:all) do
@ymlp = YMLP.new('login', 'API KEY')
end

0 comments on commit b56b539

Please sign in to comment.