Browse files

Convert README to Markdown

  • Loading branch information...
1 parent 80fb5ae commit f4bc1db30e5d814430a589696bdc32873afc4229 @tmaier tmaier committed Feb 5, 2012
Showing with 5 additions and 5 deletions.
  1. +5 −5 README.rdoc → README.md
View
10 README.rdoc → README.md
@@ -1,4 +1,4 @@
-= Markerb
+# 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.
@@ -14,20 +14,20 @@ The usage is quite simple. Assuming you have a notifier as below:
end
end
-If you create a template at <code>app/views/notifier/contact.markerb</code>:
+If you create a template at `app/views/notifier/contact.markerb`:
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 `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>;
+* 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!
-== Copyright and License
+## Copyright and License
Created by the fine folks at PlataformaTec under the MIT-LICENSE (please check MIT-LICENSE file for more info).

0 comments on commit f4bc1db

Please sign in to comment.