Skip to content
Browse files

Merge pull request #4 from tmaier/master

Version 1.0
  • Loading branch information...
2 parents 80fb5ae + cb4ed67 commit e03b326a6bbd618023aa774ce7151b66b141c39b @josevalim josevalim committed Feb 5, 2012
Showing with 50 additions and 34 deletions.
  1. +49 −0 README.md
  2. +0 −33 README.rdoc
  3. +1 −1 lib/markerb/version.rb
View
49 README.md
@@ -0,0 +1,49 @@
+# Markerb
+
+**Markerb** allows you to render multipart e-mails from a single template. The template is written in Markdown, which is delivered as a text part, but also rendered and delivered as an HTML part.
+
+The usage is quite simple. Assuming you have a notifier as below:
+
+```ruby
+class Notifier < ActionMailer::Base
+ def contact(recipient)
+ @recipient = recipient
+ mail(:to => @recipient, :from => "john.doe@example.com") do |format|
+ format.text
+ format.html
+ end
+ end
+end
+```
+
+If you create a template at `app/views/notifier/contact.markerb`:
+
+```erb
+Multipart templates **rocks**, right <%= @recipient %>?!
+```
+
+It will generate two parts, one in text and another in html when delivered. Before we finish, here are a few things you might need to know:
+
+* The `contact.markerb` template should not have a format in its name. Adding a format would make it unavailable to be rendered in different formats;
+
+* The order of the parts matter. It is important for e-mail clients that you call `format.text` before you call `format.html`;
+
+* Notice you can normally use ERb inside the template.
+
+Enjoy!
+
+## Bug reports
+
+If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as
+possible to help us fixing the possible bug. We also encourage you to help even more by forking and
+sending us a pull request.
+
+https://github.com/plataformatec/markerb/issues
+
+## Maintainers
+
+* José Valim (https://github.com/josevalim)
+
+## License
+
+MIT License. Copyright 2012 Plataforma Tecnologia. http://blog.plataformatec.com.br
View
33 README.rdoc
@@ -1,33 +0,0 @@
-= Markerb
-
-Markerb allows you to render multipart e-mails from a single template. The template is written in Markdown, which is delivered as a text part, but also rendered and delivered as an HTML part.
-
-The usage is quite simple. Assuming you have a notifier as below:
-
- class Notifier < ActionMailer::Base
- def contact(recipient)
- @recipient = recipient
- mail(:to => @recipient, :from => "john.doe@example.com") do |format|
- format.text
- format.html
- end
- end
- end
-
-If you create a template at <code>app/views/notifier/contact.markerb</code>:
-
- Multipart templates **rocks**, right <%= @recipient %>?!
-
-It will generate two parts, one in text and another in html when delivered. Before we finish, here are a few things you might need to know:
-
-* The "contact.markerb" template should not have a format in its name. Adding a format would make it unavailable to be rendered in different formats;
-
-* The order of the parts matter. It is important for e-mail clients that you call <code>format.text</code> before you call <code>format.html</code>;
-
-* Notice you can normally use ERb inside the template.
-
-Enjoy!
-
-== Copyright and License
-
-Created by the fine folks at PlataformaTec under the MIT-LICENSE (please check MIT-LICENSE file for more info).
View
2 lib/markerb/version.rb
@@ -1,3 +1,3 @@
module Markerb
- VERSION = "0.1.0"
+ VERSION = "1.0.0"
end

0 comments on commit e03b326

Please sign in to comment.
Something went wrong with that request. Please try again.