Update and rename README.md to readme.md

ciruz · Nov 9, 2013 · d4545ef · d4545ef
1 parent 032d24b
commit d4545ef
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
diff --git a/readme.md b/readme.md
@@ -0,0 +1,12 @@
+## esoTalk Avatar Reflection
+
+This plugin for esoTalk adds a reflection effect underneath user avatars in conversations and user profiles.
+
+It uses [Reflection.js for jQuery](http://www.digitalia.be/software/reflectionjs-for-jquery), so it works on all modern browsers and also on the mobile design from esoTalk.
+
+### Installing Avatar Reflection
+---------------------------------------
+1. [Download the plugin](https://github.com/ciruz/esoTalk-AvatarReflection/archive/master.zip)
+2. Extract the containing folder "**AvatarReflection**" into the plugins folder of your esoTalk installation (*esoTalk/addons/plugins/*)
+3. Enable the plugin in admin panel
+4. Done