diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..bf68d414e6f1d4e65be98e203ed04f2ae29225ea --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# zig-time + +Exposes a `DateTime` structure that can be initialized and acted upon using various methods. All public methods return a new structure. + +Currently handles dates and times based on the [Proleptic Gregorian calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar) in adherence to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). + +Does not currently handle leap seconds. + +See the `FormatSeq` structure for display information on what to pass as a `fmt` string.