Create README.md

desmondhume · Sep 8, 2015 · 8f0a6d7 · 8f0a6d7
1 parent aacc486
commit 8f0a6d7
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+### Urlo
+
+A node package to generate url from a string and params
+
+Urlo does just one thing:
+
+```
+var urlo  = require("urlo");
+var myUrl = "http://my-awesome-site.com/author/:authorId/posts/:postId";
+
+urlo(url, { authorId: 1, postId: 2, otherParam: "awesome" })
+=> 'http://my-awesome-site.com/author/1/posts/2?otherParam=awesome'
+```