From 82bf1f0f7ac41ea39cd49197d37eca5e7e155140 Mon Sep 17 00:00:00 2001 From: Jon Shallow Date: Tue, 23 May 2023 14:43:12 +0100 Subject: [PATCH] documentation: Fix bad url and hyperlink the RFCs --- README.md | 27 ++++++++++++++------------- doc/main.md | 27 ++++++++++++++------------- 2 files changed, 28 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index be2200ac..7e89712f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ libcoap is a C implementation of a lightweight application-protocol for devices that are constrained their resources such as computing power, RF range, memory, bandwidth, or network packet sizes. This protocol, CoAP, is standardized by the IETF as RFC 7252. For further -information related to CoAP, see . +information related to CoAP, see or +[CoAP Wiki](https://en.wikipedia.org/wiki/Constrained_Application_Protocol). You might want to check out [libcoap-minimal](https://github.com/obgm/libcoap-minimal) for usage @@ -37,29 +38,29 @@ Espressif/ESP-IDF hosted environments. The following RFCs are supported -* RFC7252: The Constrained Application Protocol (CoAP) +* [RFC7252: The Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7252) -* RFC7390: Group Communication for the Constrained Application Protocol (CoAP) +* [RFC7390: Group Communication for the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7390) -* RFC7641: Observing Resources in the Constrained Application Protocol (CoAP) +* [RFC7641: Observing Resources in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7641) -* RFC7959: Block-Wise Transfers in the Constrained Application Protocol (CoAP) +* [RFC7959: Block-Wise Transfers in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7959) -* RFC7967: Constrained Application Protocol (CoAP) Option for No Server Response +* [RFC7967: Constrained Application Protocol (CoAP) Option for No Server Response](https://rfc-editor.org/rfc/rfc7967) -* RFC8132: PATCH and FETCH Methods for the Constrained Application Protocol (CoAP) +* [RFC8132: PATCH and FETCH Methods for the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc8132) -* RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets +* [RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets](https://rfc-editor.org/rfc/rfc8323) -* RFC8516: "Too Many Requests" Response Code for the Constrained Application Protocol +* [RFC8516: "Too Many Requests" Response Code for the Constrained Application Protocol](https://rfc-editor.org/rfc/rfc8516) -* RFC8613: Object Security for Constrained RESTful Environments (OSCORE) +* [RFC8613: Object Security for Constrained RESTful Environments (OSCORE)](https://rfc-editor.org/rfc/rfc8613) -* RFC8768: Constrained Application Protocol (CoAP) Hop-Limit Option +* [RFC8768: Constrained Application Protocol (CoAP) Hop-Limit Option](https://rfc-editor.org/rfc/rfc8768) -* RFC8974: Extended Tokens and Stateless Clients in the Constrained Application Protocol (CoAP) +* [RFC8974: Extended Tokens and Stateless Clients in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc8974) -* RFC9175: CoAP: Echo, Request-Tag, and Token Processing +* [RFC9175: CoAP: Echo, Request-Tag, and Token Processing](https://rfc-editor.org/rfc/rfc9175) There is (D)TLS support for the following libraries diff --git a/doc/main.md b/doc/main.md index 194431ff..5be90608 100644 --- a/doc/main.md +++ b/doc/main.md @@ -13,7 +13,8 @@ libcoap is a C implementation of a lightweight application-protocol for devices that are constrained their resources such as computing power, RF range, memory, bandwidth, or network packet sizes. This protocol, CoAP, is standardized by the IETF as RFC 7252. For further -information related to CoAP, see . +information related to CoAP, see or +[CoAP Wiki](https://en.wikipedia.org/wiki/Constrained_Application_Protocol). You might want to check out [libcoap-minimal](https://github.com/obgm/libcoap-minimal) for usage @@ -21,29 +22,29 @@ examples. The following RFCs are supported -* RFC7252: The Constrained Application Protocol (CoAP) +* [RFC7252: The Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7252) -* RFC7390: Group Communication for the Constrained Application Protocol (CoAP) +* [RFC7390: Group Communication for the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7390) -* RFC7641: Observing Resources in the Constrained Application Protocol (CoAP) +* [RFC7641: Observing Resources in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7641) -* RFC7959: Block-Wise Transfers in the Constrained Application Protocol (CoAP) +* [RFC7959: Block-Wise Transfers in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7959) -* RFC7967: Constrained Application Protocol (CoAP) Option for No Server Response +* [RFC7967: Constrained Application Protocol (CoAP) Option for No Server Response](https://rfc-editor.org/rfc/rfc7967) -* RFC8132: PATCH and FETCH Methods for the Constrained Application Protocol (CoAP) +* [RFC8132: PATCH and FETCH Methods for the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc8132) -* RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets +* [RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets](https://rfc-editor.org/rfc/rfc8323) -* RFC8516: "Too Many Requests" Response Code for the Constrained Application Protocol +* [RFC8516: "Too Many Requests" Response Code for the Constrained Application Protocol](https://rfc-editor.org/rfc/rfc8516) -* RFC8613: Object Security for Constrained RESTful Environments (OSCORE) +* [RFC8613: Object Security for Constrained RESTful Environments (OSCORE)](https://rfc-editor.org/rfc/rfc8613) -* RFC8768: Constrained Application Protocol (CoAP) Hop-Limit Option +* [RFC8768: Constrained Application Protocol (CoAP) Hop-Limit Option](https://rfc-editor.org/rfc/rfc8768) -* RFC8974: Extended Tokens and Stateless Clients in the Constrained Application Protocol (CoAP) +* [RFC8974: Extended Tokens and Stateless Clients in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc8974) -* RFC9175: CoAP: Echo, Request-Tag, and Token Processing +* [RFC9175: CoAP: Echo, Request-Tag, and Token Processing](https://rfc-editor.org/rfc/rfc9175) There is (D)TLS support for the following libraries