Merge pull request #407 from mrdeep1/readme_update

README.md: Add in further information about libcoap
This commit is contained in:
obgm authored and GitHub committed 2019-09-17 12:58:37 +02:00
commit 1ccd3685ee
2 files changed
+45 -6

No files matched your search

+1 -1
View File
@@ -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
+44 -5
View File
@@ -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
<https://libcoap.net>.
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 <https://libcoap.net/install.html>
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.