From: Mike Brady <4265913+mikebrady@users.noreply.github.com>
Date: Fri, 26 Mar 2021 12:37:39 +0000 (+0000)
Subject: Update README.md
X-Git-Tag: 1.1-dev~62
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c881db2df72be650704e89b988a6ae3bc56bc7d6;p=thirdparty%2Fnqptp.git

Update README.md
---

diff --git a/README.md b/README.md
index 2c67c27..f23609b 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-# nqptp
-Not Quite a PTP daemon, `nqptp` monitors PTP traffic. Briefly, `nqptp` monitors the times of any [PTP](https://en.wikipedia.org/wiki/Precision_Time_Protocol) clocks -- up to 32 -- it sees on ports 319 and 320. It maintains a record for each clock, identified by its Clock ID and IP. This information is provided via a [POSIX shared memory](https://pubs.opengroup.org/onlinepubs/007908799/xsh/shm_open.html) interface at `/nqptp`. Here are details of the interface:
+# nqptp -- Not Quite PTP
+The `nqptp` daemon monitors PTP traffic. Briefly, `nqptp` monitors the times of any [PTP](https://en.wikipedia.org/wiki/Precision_Time_Protocol) clocks -- up to 32 -- it sees on ports 319 and 320. It maintains a record for each clock, identified by its Clock ID and IP. This information is provided via a [POSIX shared memory](https://pubs.opengroup.org/onlinepubs/007908799/xsh/shm_open.html) interface at `/nqptp`. Here are details of the interface:
 ```c
 struct clock_source {
   char ip[64];                           // the IP the clock information is coming from
@@ -45,5 +45,8 @@ Since `nqptp` uses ports 319 and 320, it can not coexist with any other user of
 * At present, `nqptp` does not take advantage of hardware timestamping.
 * The daemon is Linux only, and has been developed and tested on a `systemd` Linux only.
 
-# Things Can Change!
+# Things Can Change
 The `nqptp` daemon is under active development and, consequently, everything here can change, possibly very radically.
+
+# NQPTP is not PTP!
+`nqptp` uses a small part of the IEEE Std 1588-2008 protocol. It is not a PTP clock of any kind.