Browse files

improved Readme

  • Loading branch information...
1 parent 66a3486 commit 988de21b4163c9546e5a5452542086e4511f1839 @paraseba committed May 29, 2010
Showing with 8 additions and 3 deletions.
  1. +8 −3 README.textile
View
11 README.textile
@@ -2,7 +2,7 @@ h1. resource-url
A "clojure":http://clojure.org/ library for generating URLs.
-Documentation by autodoc: http://paraseba.github.com/resource-url/
+Documentation by autodoc: "here":http://paraseba.github.com/resource-url/
h2. Installation
@@ -24,7 +24,8 @@ You define functions that will return URLs based on a template. The simplest cas
</code>
</pre>
-This will create a function named <code>home-path</code> that will return the path "/home/en".
+This will create a function named <code>home-path</code> that will return the path
+<code>/home/en</code>.
You can pass additional URL parameters to <code>home-path</code>
@@ -56,7 +57,7 @@ Then you could user <code>picture-path</code> in the following way:
</code>
</pre>
-That will expand into <code>/users/john-doe/pictures/45/?thumb=big"</code>.
+That will expand into <code>/users/john-doe/pictures/45/?thumb=big</code>.
The first argument to <code>picture-path</code> is the object that will be used
to expand the function parts of the URL template, if more than one, pass a vector.
@@ -127,3 +128,7 @@ In fact, <code>by-member</code> exists only to increase readability:
(defn by-member [mem] (dispatch mem))
</code>
</pre>
+
+h2. Documentation
+
+Check the full documentation generated by autodoc: "here":http://paraseba.github.com/resource-url/

0 comments on commit 988de21

Please sign in to comment.