From 72e71d9a7f94735504ad134226d5949b44fe7023 Mon Sep 17 00:00:00 2001 From: dfhoughton Date: Sat, 5 Jan 2019 16:36:48 -0500 Subject: some documentation --- CHANGES.md | 7 +++++-- README.md | 22 ++++++++++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index df61a65..72cd5e8 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,6 @@ -# 1.0.0 +# Change Log + +## 1.0.0 * convert `Date` and `DateTime` everywhere to `NaiveDate` and `NaiveDateTime` -* added "weekend" for the expressions "this weekend", "last weekend", etc. \ No newline at end of file +* added "weekend" for the expressions "this weekend", "last weekend", etc. +* don't require space between era suffix and year -- "100AD" is as good as "100 AD" diff --git a/README.md b/README.md index 8353434..b30a454 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,26 @@ # two-timer Rust library for parsing English time expressions into start and end timestamps +This takes English expressions and returns a time range which ideally matches the expression. +You might use this for registering the temporal extent of an event, say, or finding +lines in a log file. + +Some expressions it can handle: + +* from now to eternity +* today +* tomorrow +* last month +* this year +* 5/6/69 +* June 6, 2010 +* forever +* 3:00 AM +* June '05 +* Monday through next Thursday +* from mon at 15:00:05 to now +* 1960-05-06 +* 5000BCE +* next weekend + The complete API is available at https://docs.rs/two_timer/0.1.0/two_timer/. -- cgit v1.2.3