Skip to content

Commit

Permalink
Install instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
petyosi committed Nov 6, 2009
1 parent 533032a commit f093d53
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.rdoc
@@ -1,33 +1,43 @@
= Postmark rails gem

Postmark plug-in for ActionMailer
Postmark plug-in for ActionMailer

== Installation
== Install

The gem is hosted at gemcutter. If you don't have it, install it first:

sudo gem install gemcutter
gem tumble

Then
sudo gem install postmark-rails

== Example

#config/environment.rb

Rails::Initializer.run do |config|

config.gem 'postmark-rails'
config.action_mailer.delivery_method = :postmark
config.action_mailer.postmark_api_key = "your-api-key"
# ...
end

== Limitations
Currently postmark API does not support multiple recipients, or attachments. For more information, check the docs here:
TODO: URL to docs.

== Requirements

You will also need postmark account, server and sender signature set up to use it.
You will also need postmark account, server and sender signature set up to use it.

== Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
* Add tests for it. This is important so I don't break it in a future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
* Send me a pull request. Bonus points for topic branches.

== Copyright
Expand Down
61 changes: 61 additions & 0 deletions postmark-rails.gemspec
@@ -0,0 +1,61 @@
# Generated by jeweler
# DO NOT EDIT THIS FILE
# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
# -*- encoding: utf-8 -*-

Gem::Specification.new do |s|
s.name = %q{postmark-rails}
s.version = "0.1.0"

s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Petyo Ivanov"]
s.date = %q{2009-11-04}
s.description = %q{Use this plugin in your rails applications to send emails through the Postmark API}
s.email = %q{underlog@gmail.com}
s.extra_rdoc_files = [
"LICENSE",
"README.rdoc"
]
s.files = [
".document",
".gitignore",
"LICENSE",
"README.rdoc",
"Rakefile",
"VERSION",
"lib/postmark-rails.rb",
"spec/fixtures/models/test_mailer.rb",
"spec/fixtures/views/test_mailer/multipart_message.text.html.erb",
"spec/fixtures/views/test_mailer/multipart_message.text.plain.erb",
"spec/fixtures/views/test_mailer/simple_message.erb",
"spec/postmark-rails_spec.rb",
"spec/spec.opts",
"spec/spec_helper.rb"
]
s.homepage = %q{http://postmarkapp.com}
s.rdoc_options = ["--charset=UTF-8"]
s.require_paths = ["lib"]
s.rubygems_version = %q{1.3.4}
s.summary = %q{Postmark adapter for ActionMailer}
s.test_files = [
"spec/fixtures/models/test_mailer.rb",
"spec/postmark-rails_spec.rb",
"spec/spec_helper.rb"
]

if s.respond_to? :specification_version then
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
s.specification_version = 3

if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
s.add_development_dependency(%q<rspec>, [">= 0"])
s.add_runtime_dependency(%q<postmark>, [">= 0"])
else
s.add_dependency(%q<rspec>, [">= 0"])
s.add_dependency(%q<postmark>, [">= 0"])
end
else
s.add_dependency(%q<rspec>, [">= 0"])
s.add_dependency(%q<postmark>, [">= 0"])
end
end

0 comments on commit f093d53

Please sign in to comment.