Merge pull request #35 from tippenein/readme-details

Updated datetime details in Readme

Author: safareli

README.md

@@ -42,26 +42,30 @@ then use formatter to result of division of input number and that power.
 
 ## Date/Time formatters
 
-This is just subset of format/parse string from moment.js library. Currently supported
-+ `YYYY`
-+ `YY`
-+ `MMMM`
-+ `MMM`
-+ `MM`
-+ `DD`
-+ `D`
-+ `X`
-+ `E`
-+ `HH`
-+ `hh`
-+ `a`
-+ `mm`
-+ `m`
-+ `ss`
-+ `s`
-+ `SSS`
-+ `SS`
-+ `S`
+This is a subset of common format/parse strings currently supported.
+
++ `YYYY` - Full Year      (1999)
++ `YY`   - 2 digit year   (99)
++ `MMMM` - Full Month     (January)
++ `MMM`  - Short Month    (Jan)
++ `DD`   - Padded Day     (02)
++ `D`    - Day of month   (2)
++ `X`    - Unix Timestamp (1506875681)
++ `E`    - Day of Week    (2)
++ `dddd` - DOW Name       (Monday)
++ `ddd`  - DOW Name Short (Mon)
++ `HH`   - 24 Hour        (13)
++ `hh`   - 12 Hour        (1)
++ `a`    - Meridiem       (am/pm)
++ `mm`   - Minutes Padded (02)
++ `m`    - Minutes        (2)
++ `ss`   - Seconds Padded (02)
++ `s`    - Seconds        (2)
++ `S`    - MilliSeconds   (4)
++ `SS`   - MilliSeconds   (04)
++ `SSS`  - MilliSeconds   (004)
+
+Full list is defined [here](https://github.com/slamdata/purescript-formatters/blob/master/src/Data/Formatter/DateTime.purs)
 
 ## Documentation
 

test/src/DateTime.purs

@@ -15,7 +15,7 @@ import Test.Utils (forAll, makeDateTime)
 datetimeTest ∷ ∀ e. Spec e Unit
 datetimeTest = describe "Data.Formatter.DateTime" do
   forAll (\a → a.format <> " | " <> a.dateStr)
-    "formatDateTime/unformaDateTime should formatt/unforma dateTime"
+    "formatDateTime/unformatDateTime should format/unformat dateTime"
     [ { format: "MM/DD/YYYY", dateStr: "04/12/2017" , date: makeDateTime 2017 4 12 11 3 4 234}
     , { format: "YYYY", dateStr: "0017" , date: makeDateTime 17 0 0 0 0 0 0}
     , { format: "MMMM", dateStr: "April" , date: makeDateTime 2017 4 12 11 3 4 234}
@@ -24,6 +24,7 @@ datetimeTest = describe "Data.Formatter.DateTime" do
     , { format: "MMM D", dateStr: "Apr 1" , date: makeDateTime 2017 4 1 0 0 0 0}
     , { format: "dddd, MMM D", dateStr: "Saturday, Apr 1" , date: makeDateTime 2017 4 1 0 0 0 0}
     , { format: "ddd, MMM D", dateStr: "Sat, Apr 1" , date: makeDateTime 2017 4 1 0 0 0 0}
+    , { format: "E", dateStr: "6", date: makeDateTime 2017 4 1 0 0 0 0}
     , { format: "hh:mm:ss:SSS a", dateStr: "11:03:04:234 AM" , date: makeDateTime 2017 4 12 11 3 4 234}
     , { format: "YY", dateStr: "17" , date: makeDateTime 2017 4 12 11 3 4 234}
     , { format: "YY", dateStr: "17" , date: makeDateTime 20017 4 12 0 0 0 0} -- Format 20017 with YY