Permalink
Browse files

Add readme

  • Loading branch information...
1 parent 6dc35ea commit 55b0a872894403b54faf63ca9e0ef648c79f4210 @ForbesLindesay committed Feb 24, 2013
Showing with 25 additions and 3 deletions.
  1. +25 −3 README.md
View
@@ -1,4 +1,26 @@
-dehumanize-date
-===============
+# dehumanize-date
-Parse dates in all the formats humans like to use.
+Parse dates in all the formats humans like to use:
+
+ - today/tomorrow/yesterday
+ - next/this/last Wednesday
+ - 12th January
+ - 12th January 1950
+ - 09-08-2008
+ - 2008-08-09
+
+## Installation
+
+ $ npm install dehumanize-date
+
+ or
+
+ $ component install ForbesLindesay/dehumanize-date
+
+## Usage
+
+A simple function which takes a string as an argument and returns a plain JavaScript date object.
+
+```javascript
+var date = dehumanizeDate(userInput);
+```

0 comments on commit 55b0a87

Please sign in to comment.