Permalink
Browse files

add docs

  • Loading branch information...
1 parent adbfdac commit 3399f4bb70d4083ef8f01f15211d578bf8814730 TJ Holowaychuk committed Sep 30, 2012
Showing with 21 additions and 1 deletion.
  1. +21 −1 Readme.md
View
@@ -1,5 +1,25 @@
# humanize-number
- Humanize a number (1000000 -> 1,000,000)
+ Humanize a number `1000000.99` -> `1,000,000.99`
+
+## Installation
+
+ $ component install component/humanize-number
+
+## Example
+
+```js
+var humanize = require('humanize-number');
+
+humanize(1000);
+// => '1,000'
+
+humanize(1000.55, { delimiter: '.', separator: ',' });
+// => '1.000,55'
+```
+
+## License
+
+ MIT

0 comments on commit 3399f4b

Please sign in to comment.