READMEを修正

hozumi · Jan 7, 2011 · f7012df · f7012df
1 parent 6187e9b
commit f7012df
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 18 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,40 @@
+# clj-gravatar
+
+gravatar api wrapper for clojure
+http://ja.gravatar.com/
+
+## Usage
+
+### gravatar image
+
+    (gravatar-image "your@mail.address")
+
+#### option
+ * size
+  * avatar image size
+ * default
+  * default image url
+ * secure?
+  * https flag. default is false
+
+#### option example
+
+    (gravatar-image "your@mail.address" :size 24 :default "http://hoge.com/fuga.png" :secure? true)
+
+### gravatar profile
+
+    (gravatar-profile "your@mail.address")
+
+#### option
+ * secure?
+  * https flag. default is false
+
+#### option example
+
+    (gravatar-profile "your@mail.address" :secure? true)
+
+## License
+
+Copyright (C) 2011 Masashi Iizuka
+
+Distributed under the Eclipse Public License, the same as Clojure.