From 7b9fe948491e5c01b89b04f8adb387ab871634ce Mon Sep 17 00:00:00 2001 From: Rop Date: Sat, 15 Sep 2018 11:29:31 +0200 Subject: [PATCH] small README fixes --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2c6515e..e56cc57 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ Jump to:   [Table of Contents](#table-of-contents)  —  [Function Reference](#function-reference)  —  [dateTime function](#datetime) -# ezTime, an Arduino library for all of time * +# ezTime, an Arduino library for all of time * -                                            written by Rop Gonggrijp +                                            written by Rop Gonggrijp **ezTime — pronounced "Easy Time" — is a very easy to use Arduino time and date library that provides NTP network time lookups, extensive timezone support, formatted time and date strings, user events, millisecond precision and more.** -                                                                                                                                       * limitations may apply, see "[2036 and 2038](#2036-and-2038)" chapter +                                                                                                                                        * limitations may apply, see "[2036 and 2038](#2036-and-2038)" chapter ![](images/moving-clock.gif) @@ -520,7 +520,9 @@ if (weekday() == TUESDAY) Serial.print("Tuesday!!"); if (month() == FEBRUARY && day() == 14) Serial.print("Valentine's day!"); ``` -`bool isAM(TIME)`
+  + +`bool isAM(TIME)`    — Both assume default timezone if no timezone is prefixed
`bool isPM(TIME)` These will tell if it is before or after noon for a given `TIME`, return `true` or `false`. @@ -1028,8 +1030,8 @@ ezTime 0.7.2 runs fine (No networking on board, so tested with NoNetwork example | [**`setLocation`**](#setlocation) | `bool` | `String location = ""` | yes | yes | no | [**`setPosix`**](#setposix) | `bool` | `String posix` | yes | yes | no | [**`setServer`**](#setserver-and-setinterval) | `void` | `String ntp_server = NTP_SERVER` | no | yes | no -| [**`setTime`**](#settime) | `void` | `time_t t`, `uint16_t ms = 0` | optional | yes | no -| [**`setTime`**](#settime) | `void` | `uint8_t hr`, `uint8_t min`, `uint8_t sec`, `uint8_t day`, `uint8_t mnth`, `uint16_t yr` | optional | yes | no +| [**`setTime`**](#settime) | `void` | `time_t t`, `uint16_t ms = 0` | optional | no | no +| [**`setTime`**](#settime) | `void` | `uint8_t hr`, `uint8_t min`, `uint8_t sec`, `uint8_t day`, `uint8_t mnth`, `uint16_t yr` | optional | no | no | [**`timeStatus`**](#timestatus) | `timeStatus_t` | | no | no | no | [**`tzTime`**](#tztime) | `time_t` | `TIME` | yes | no | no | [**`tzTime`**](#tztime) | `time_t` | `TIME`, `String &tzname`, `bool &is_dst`, `int16_t &offset` | yes | no | no