Preparing for v1.1.0 release from esp32_idf5_https_server

Author: jackjansen

CHANGELOG.md

@@ -1,18 +1,10 @@
 # Changelog
 
-## [pending (master)](https://github.com/fhessel/esp32_https_server/tree/master)
+## [v1.1.0](https://github.com/jackjansen/esp32_idf5_https_server/tree/master)
 
-New functionality:
-
-–
-
-Bug fixes:
-
-–
-
-Breaking changes:
+- Compatible with ESP-IDF 5.0
+- Use esp-tls in stead of openssl
 
-–
 
 ## [v1.0.0](https://github.com/fhessel/esp32_https_server/releases/tag/v1.0.0)
 

README.md

@@ -1,6 +1,14 @@
-# ESP32 HTTPS Server
+# ESP32 HTTPS Server, IDF5 fork
 
-![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/fhessel/esp32_https_server?label=Version&sort=semver) ![Build Examples](https://github.com/fhessel/esp32_https_server/workflows/Build%20Examples/badge.svg?branch=master)
+This repository is a fork of `fhessel/esp32_https_server`. The only reason for its existence is that it seems _fhessel_ currently does not have the time to maintain `esp32_https_server`, and due to changes in the underlying Espressif frameworks such as `ESP_IDF` it has stopped working.
+
+This forked repository has just enough changes so that the library works. It is hoped that it will go away in the future (after a warning period) when `esp32_idf_server` maintainance is picked up again.
+
+In the following instructions
+
+- replace every mention of `esp32_https_server` with `esp32_idf5_https_server`
+
+## Original readme of esp32_https_server
 
 This repository contains an HTTPS server library that can be used with the [ESP32 Arduino Core](https://github.com/espressif/arduino-esp32). It supports HTTP as well.
 

library.json

@@ -1,14 +1,14 @@
 {
-  "name": "esp32_https_server",
+  "name": "esp32_idf5_https_server",
   "keywords": "communication, esp32, http, https, server, ssl, tls, webserver, websockets",
-  "description": "Alternative ESP32 Webserver implementation for the ESP32, supporting HTTPS and HTTP. The library provides TLS support and simultaneous connections. It can be used to run an HTTP or HTTPS server, or both in parallel. The server's resources are defined through handler and middleware functions, giving an easy start to everyone who has worked with frameworks like Express or Servlets before.",
+  "description": "Alternative ESP32 Webserver implementation for the ESP32, supporting HTTPS and HTTP. The library provides TLS support and simultaneous connections. It can be used to run an HTTP or HTTPS server, or both in parallel. The server's resources are defined through handler and middleware functions, giving an easy start to everyone who has worked with frameworks like Express or Servlets before. This fork is compatible with ESP-IDF 5.0 or later.",
   "repository":
   {
     "type": "git",
-    "url": "https://github.com/fhessel/esp32_https_server.git"
+    "url": "https://github.com/jackjansen/esp32_idf5_https_server.git"
   },
   "license": "MIT",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "frameworks": "arduino",
   "platforms": ["espressif32"]
 }

library.properties

@@ -1,10 +1,10 @@
-name=ESP32_HTTPS_Server
+name=ESP32_IDF5_HTTPS_Server
 version=1.0.0
 author=Frank Hessel <frank@fhessel.de>
-maintainer=Frank Hessel <frank@fhessel.de>
-sentence=Alternative ESP32 Webserver implementation for the ESP32, supporting HTTPS and HTTP.
+maintainer=Jack Jansen <Jack.Jansen@cwi.nl>
+sentence=Alternative ESP32 Webserver implementation for the ESP32, supporting HTTPS and HTTP. Compatible with ESP-IDF 5.0 or later.
 paragraph=The library provides TLS support and simultaneous connections. It can be used to run an HTTP or HTTPS server, or both in parallel. The server's resources are defined through handler and middleware functions, giving an easy start to everyone who has worked with frameworks like Express or Servlets before.
 category=Communication
-url=https://github.com/fhessel/esp32_https_server
+url=https://github.com/jackjansen/esp32_idf5_https_server
 architectures=esp32
 includes=HTTPSServer.hpp,HTTPRequest.hpp,HTTPResponse.hpp