From 6e25d9df910ac2129e4657d1bf85be9154687928 Mon Sep 17 00:00:00 2001 From: Jon Shallow Date: Mon, 16 Sep 2019 10:18:16 +0100 Subject: [PATCH] README.md: Add in further information about libcoap Add in information on Documentation and Building. Update the Package contents. LICENCE: Update date. --- LICENSE | 2 +- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 45 insertions(+), 6 deletions(-) diff --git a/LICENSE b/LICENSE index b4052170..8f6cb3c6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2010--2017, Olaf Bergmann and others +Copyright (c) 2010--2019, Olaf Bergmann and others All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/README.md b/README.md index 3cdfa583..7a8ea55e 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,50 @@ You might want to check out [libcoap-minimal](https://github.com/obgm/libcoap-minimal) for usage examples. +DOCUMENTATION +============= + +Documentation and further information can be found at +. + PACKAGE CONTENTS ================ -This directory contains a protocol parser and basic networking -functions for platform with support for malloc() and BSD-style -sockets. The examples directory contains a client and a server to -demonstrate the use of this library. +This package contains a protocol parser and basic networking +functions for platforms with support for malloc() and BSD-style +sockets. In addition, there is support for Contiki, LwIP and +Espressif/ESP-IDF hosted environments. + +The following RFCs are supported + +* RFC7252: The Constrained Application Protocol (CoAP) + +* RFC7641: Observing Resources in the Constrained Application Protocol (CoAP) + +* RFC7959: Block-Wise Transfers in the Constrained Application Protocol (CoAP) + +* RFC7967: Constrained Application Protocol (CoAP) Option for No Server Response + +* RFC8132: PATCH and FETCH Methods for the Constrained Application Protocol (CoAP) + +* RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets + +There is (D)TLS support for the following libraries + +* OpenSSL (Minimum verion 1.1.0) + +* GnuTLS (Minimum version 3.3.0) + +* TinyDTLS + +The examples directory contain a CoAP client, CoAP Resource Directory server +and a CoAP server to demonstrate the use of this library. + +BUILDING +======== + +Further information can be found at +and [BUILDING](https://raw.githubusercontent.com/obgm/libcoap/develop/BUILDING). LICENSE INFORMATION =================== @@ -33,5 +70,7 @@ This library is published as open-source software without any warranty of any kind. Use is permitted under the terms of the simplified BSD license. It includes public domain software. libcoap binaries may also include open-source software with their respective licensing terms. -Please refer to LICENSE for further details. +Please refer to +[LICENSE](https://raw.githubusercontent.com/obgm/libcoap/develop/LICENSE) +for further details.