From 2e1ed890b85d4ecf1a6332cf2e0c121d5640b496 Mon Sep 17 00:00:00 2001
From: Vincent LE GOFF <g_n_s@hotmail.fr>
Date: Mon, 18 Mar 2019 16:08:01 +0100
Subject: Documentation clean up (denoland/deno_std#288)

Original: https://github.com/denoland/deno_std/commit/b699fa67befaef4423f365e55eff0fec2e14def8
---
 datetime/README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 datetime/README.md

(limited to 'datetime')

diff --git a/datetime/README.md b/datetime/README.md
new file mode 100644
index 000000000..470aba651
--- /dev/null
+++ b/datetime/README.md
@@ -0,0 +1,37 @@
+# datetime
+
+Simple helper to help parse date strings into `Date`, with additionnal functions.
+
+## Usage
+
+### parseDate / parseDateTime
+
+- `parseDate()` - Take an input string and a format to parse the date. Supported formats are exported in `DateFormat`.
+- `parseDateTime()` - Take an input string and a format to parse the dateTime. Supported formats are exported in `DateTimeFormat`.
+
+```ts
+import { parseDate, parseDateTime } from 'https://deno.land/std/datetime/mod.ts'
+
+parseDate("03-01-2019", "dd-mm-yyyy") // output : new Date(2019, 1, 3)
+parseDate("2019-01-03", "yyyy-mm-dd") // output : new Date(2019, 1, 3)
+...
+
+parseDateTime("01-03-2019 16:34", "mm-dd-yyyy hh:mm") // output : new Date(2019, 1, 3, 16, 34)
+parseDateTime("16:34 01-03-2019", "hh:mm mm-dd-yyyy") // output : new Date(2019, 1, 3, 16, 34)
+...
+```
+
+### dayOfYear / currentDayOfYear
+
+- `dayOfYear()` - Returns the number of the day in the year.
+- `currentDayOfYear()` - Returns the number of the current day in the year.
+
+```ts
+import {
+  dayOfYear,
+  currentDayOfYear
+} from "https://deno.land/std/datetime/mod.ts";
+
+dayOfYear(new Date("2019-03-11T03:24:00")); // output: 70
+currentDayOfYear(); // output: ** depends on when you run it :) **
+```
-- 
cgit v1.2.3