adding readme.md, removing old readme

ivantcholakov · Jan 6, 2012 · 4713971 · 4713971
1 parent 4800873
commit 4713971
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 12 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/nbproject/*
diff --git a/README b/README
diff --git a/README.MD b/README.MD
@@ -0,0 +1,12 @@
+Gravatar library for Codeigniter by Ryan Marshall
+=================================================
+
+To use simply load the library as usual in your controller
+
+    $this->load->library('gravatar');
+
+After this you can call any of the functions such as :
+
+    $this->gravatar->get_gravatar('emailhere');
+
+The class is documented in the file, for any further help drop me a message on [github](https://github.com/rsmarshall) or on [twitter @rsmarshall](http://www.twitter.com/rsmarshall