updated the README

easy-designs · Jan 24, 2014 · 87dca1d · 87dca1d
1 parent adcea76
commit 87dca1d
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,15 @@
-easy_email_obfuscator.ee_addon
-==============================
+Easy Email Obfuscator for ExpressionEngine
+==========================================
 
-Email obfuscation &amp; de-obfuscation for ExpressionEngine
+To obfuscate an email address, simply encode it:
+
+	{exp:easy_email_obfuscator:encode}[email protected]{/exp:easy_email_obfuscator:encode}
+
+That will make your email address appear as
+
+	<em>me [at] domain [dot] com</em>
+
+Which should fool most harvesters. To decode it again, insert the decoder JavaScript at the bottom of your page (just before closing the body):
+
+  		{exp:easy_email_obfuscator:jsdecode}
+	</body>