Skip to content
This repository was archived by the owner on Feb 4, 2023. It is now read-only.

Commit 4e24ef2

Browse files
authored
Update README.md and use allman astyle
1 parent 735058c commit 4e24ef2

File tree

9 files changed

+1006
-989
lines changed

9 files changed

+1006
-989
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Please ensure to specify the following:
2929
Arduino IDE version: 1.8.19
3030
ESP32 Core Version 2.0.5
3131
OS: Ubuntu 20.04 LTS
32-
Linux xy-Inspiron-3593 5.15.0-52-generic #58~20.04.1-Ubuntu SMP Thu Oct 13 13:09:46 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
32+
Linux xy-Inspiron-3593 5.15.0-53-generic #59~20.04.1-Ubuntu SMP Thu Oct 20 15:10:22 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
3333
3434
Context:
3535
I encountered a crash while using this library

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# AsyncHTTPSRequest_Generic
1+
# AsyncHTTPSRequest_Generic Library
22

33
[![arduino-library-badge](https://www.ardu-badge.com/badge/AsyncHTTPSRequest_Generic.svg?)](https://www.ardu-badge.com/AsyncHTTPSRequest_Generic)
44
[![GitHub release](https://img.shields.io/github/release/khoih-prog/AsyncHTTPSRequest_Generic.svg)](https://github.com/khoih-prog/AsyncHTTPSRequest_Generic/releases)
55
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
66
[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/AsyncHTTPSRequest_Generic.svg)](http://github.com/khoih-prog/AsyncHTTPSRequest_Generic/issues)
77

8+
89
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
910
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
11+
<a href="https://profile-counter.glitch.me/khoih-prog/count.svg" title="Total khoih-prog Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog/count.svg" style="height: 30px;width: 200px;"></a>
12+
<a href="https://profile-counter.glitch.me/khoih-prog-AsyncHTTPSRequest_Generic/count.svg" title="AsyncHTTPSRequest_Generic Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog-AsyncHTTPSRequest_Generic/count.svg" style="height: 30px;width: 200px;"></a>
1013

1114
---
1215
---
@@ -164,7 +167,6 @@ This library is based on, modified from:
164167
3. **STM32 using built-in LAN8742A**
165168
4. **Portenta_H7 using either Ethernet or built-in WiFi**
166169

167-
168170
---
169171
---
170172

@@ -183,6 +185,7 @@ This library is based on, modified from:
183185
## Installation
184186

185187
### Use Arduino Library Manager
188+
186189
The best and easiest way is to use `Arduino Library Manager`. Search for `AsyncHTTPSRequest_Generic`, then select / install the latest version. You can also use this link [![arduino-library-badge](https://www.ardu-badge.com/badge/AsyncHTTPSRequest_Generic.svg?)](https://www.ardu-badge.com/AsyncHTTPSRequest_Generic) for more detailed instructions.
187190

188191
### Manual Install
@@ -346,7 +349,7 @@ https://github.com/khoih-prog/AsyncHTTPSRequest_Generic/blob/67580364d2ecb2f3eb1
346349
347350
Following is the debug terminal when running example [AsyncHTTPSRequest_ESP](examples/AsyncHTTPSRequest_ESP) on ESP32_DEV to demonstrate the operation of SSL Async HTTPS request, using [AsyncTCP_SSL Library](https://github.com/khoih-prog/AsyncTCP_SSL).
348351
349-
```
352+
```cpp
350353
Starting AsyncHTTPSRequest_ESP using ESP32_DEV
351354
AsyncTCP_SSL v1.3.1
352355
AsyncHTTPSRequest_Generic v2.2.1
@@ -405,7 +408,7 @@ week_number: 45
405408

406409
Following is the debug terminal when running example [AsyncHTTPSRequest_ESP](examples/AsyncHTTPSRequest_ESP) on ESP32S2_DEV to demonstrate the operation of SSL Async HTTPS request, using [AsyncTCP_SSL Library](https://github.com/khoih-prog/AsyncTCP_SSL).
407410

408-
```
411+
```cpp
409412
Starting AsyncHTTPSRequest_ESP using ESP32S2_DEV
410413
AsyncTCP_SSL v1.3.1
411414
AsyncHTTPSRequest_Generic v2.2.1
@@ -482,7 +485,7 @@ week_number: 45
482485

483486
Following is the debug terminal when running example [AsyncHTTPSRequest_ESP](examples/AsyncHTTPSRequest_ESP) on ESP32C3_DEV to demonstrate the operation of SSL Async HTTPS request, using [AsyncTCP_SSL Library](https://github.com/khoih-prog/AsyncTCP_SSL).
484487

485-
```
488+
```cpp
486489
Starting AsyncHTTPSRequest_ESP using ESP32C3_DEV
487490
AsyncTCP_SSL v1.3.1
488491
AsyncHTTPSRequest_Generic v2.2.1
@@ -535,7 +538,7 @@ week_number: 45
535538

536539
Following is the debug terminal when running example [AsyncHTTPSRequest_ESP_WiFiManager](examples/AsyncHTTPSRequest_ESP_WiFiManager) on ESP32_DEV to demonstrate the operation of SSL Async HTTPS request, using [AsyncTCP_SSL Library](https://github.com/khoih-prog/AsyncTCP_SSL), and [ESPAsync_WiFiManager Library](https://github.com/khoih-prog/ESPAsync_WiFiManager)
537540

538-
```
541+
```cpp
539542
Starting AsyncHTTPSRequest_ESP_WiFiManager using LittleFS on ESP32_DEV
540543
ESPAsync_WiFiManager v1.15.0
541544
AsyncTCP_SSL v1.3.1
@@ -571,7 +574,7 @@ H
571574

572575
Following is the debug terminal when running example [AsyncHTTPSRequest_WT32_ETH01](examples/WT32_ETH01/AsyncHTTPSRequest_WT32_ETH01) on WT32_ETH01 to demonstrate the operation of SSL Async HTTPS request, using [AsyncTCP_SSL Library](https://github.com/khoih-prog/AsyncTCP_SSL) and **ESP32 core v2.0.0**
573576

574-
```
577+
```cpp
575578
Starting AsyncHTTPSRequest_WT32_ETH01 using ESP32_DEV with ETH_PHY_LAN8720
576579
WebServer_WT32_ETH01 v1.5.0 for core v2.0.0+
577580
AsyncTCP_SSL v1.3.1
@@ -605,7 +608,7 @@ week_number: 45
605608

606609
Following is the debug terminal when running example [AsyncHTTPSRequest_WT32_ETH01](examples/WT32_ETH01/AsyncHTTPSRequest_WT32_ETH01) on WT32_ETH01 to demonstrate the operation of SSL Async HTTPS request, using [AsyncTCP_SSL Library](https://github.com/khoih-prog/AsyncTCP_SSL) and **ESP32 core v1.0.6**
607610

608-
```
611+
```cpp
609612
Starting AsyncHTTPSRequest_WT32_ETH01 using ESP32_DEV with ETH_PHY_LAN8720
610613
WebServer_WT32_ETH01 v1.5.0 for core v1.0.6-
611614
AsyncTCP_SSL v1.3.1
@@ -639,7 +642,7 @@ week_number: 45
639642

640643
Following is the debug terminal when running example [AsyncHTTPSRequest_ESP_WiFiManager](examples/AsyncHTTPSRequest_ESP_WiFiManager) on ESP32C3_DEV to demonstrate the operation of SSL Async HTTPS request, using [AsyncTCP_SSL Library](https://github.com/khoih-prog/AsyncTCP_SSL), and [ESPAsync_WiFiManager Library](https://github.com/khoih-prog/ESPAsync_WiFiManager)
641644

642-
```
645+
```cpp
643646
Starting AsyncHTTPSRequest_ESP_WiFiManager using LittleFS on ESP32C3_DEV
644647
ESPAsync_WiFiManager v1.15.0
645648
AsyncHTTPSRequest_Generic v2.2.1
@@ -696,7 +699,7 @@ HH
696699

697700
Following is the debug terminal when running example [AsyncHTTPSRequest_ESP_WiFiManager](examples/AsyncHTTPSRequest_ESP_WiFiManager) on ESP32S3_DEV to demonstrate the operation of SSL Async HTTPS request, using [AsyncTCP_SSL Library](https://github.com/khoih-prog/AsyncTCP_SSL), and [ESPAsync_WiFiManager Library](https://github.com/khoih-prog/ESPAsync_WiFiManager)
698701

699-
```
702+
```cpp
700703
Starting AsyncHTTPSRequest_ESP_WiFiManager using LittleFS on ESP32S3_DEV
701704
ESPAsync_WiFiManager v1.15.0
702705
AsyncHTTPSRequest_Generic v2.2.1
@@ -732,7 +735,7 @@ HHHH
732735

733736
The terminal output of [AsyncHTTPSRequest_ESP_Multi example](examples/AsyncHTTPSRequest_ESP_Multi) running on `ESP32_DEV` to demonstrate how to send requests to multiple addresses and receive responses from them.
734737

735-
```
738+
```cpp
736739
Starting AsyncHTTPSRequest_ESP_Multi on ESP32_DEV
737740
AsyncTCP_SSL v1.3.1
738741
AsyncHTTPSRequest_Generic v2.2.1
@@ -806,7 +809,7 @@ H
806809

807810
The terminal output of [AsyncHTTP_HTTPSRequest_ESP example](examples/AsyncHTTP_HTTPSRequest_ESP) running on `ESP32_DEV` to demonstrate how to send HTTP and HTTPS requests to multiple addresses and receive responses from them.
808811

809-
```
812+
```cpp
810813
Starting AsyncHTTP_HTTPSRequest_ESP on ESP32_DEV
811814
AsyncTCP_SSL v1.3.1
812815
AsyncHTTPSRequest_Generic v2.2.1
@@ -927,7 +930,7 @@ Submit issues to: [AsyncHTTPSRequest_Generic issues](https://github.com/khoih-pr
927930

928931
1. Fix bug. Add enhancement
929932
2. Add support to more Ethernet / WiFi shields
930-
3. Add support to RP2040W, ESP8266, Portenta_H7, STM32 and many more boards
933+
3. Add support to `RP2040W`, `ESP8266`, `Portenta_H7`, `STM32` and many more boards
931934
4. Add many more examples.
932935

933936
---
@@ -955,6 +958,8 @@ Submit issues to: [AsyncHTTPSRequest_Generic issues](https://github.com/khoih-pr
955958
19. Not try to reconnect to the same `host:port` after connected.
956959
20. Fix crash and memory leak
957960
21. Default to reconnect to the same `host:port` after connected for new HTTP sites.
961+
22. Use `allman` astyle
962+
958963

959964
---
960965
---

changelog.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1-
# AsyncHTTPSRequest_Generic
1+
# AsyncHTTPSRequest_Generic Library
22

33
[![arduino-library-badge](https://www.ardu-badge.com/badge/AsyncHTTPSRequest_Generic.svg?)](https://www.ardu-badge.com/AsyncHTTPSRequest_Generic)
44
[![GitHub release](https://img.shields.io/github/release/khoih-prog/AsyncHTTPSRequest_Generic.svg)](https://github.com/khoih-prog/AsyncHTTPSRequest_Generic/releases)
55
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
66
[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/AsyncHTTPSRequest_Generic.svg)](http://github.com/khoih-prog/AsyncHTTPSRequest_Generic/issues)
77

8+
9+
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
10+
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
11+
<a href="https://profile-counter.glitch.me/khoih-prog/count.svg" title="Total khoih-prog Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog/count.svg" style="height: 30px;width: 200px;"></a>
12+
<a href="https://profile-counter.glitch.me/khoih-prog-AsyncHTTPSRequest_Generic/count.svg" title="AsyncHTTPSRequest_Generic Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog-AsyncHTTPSRequest_Generic/count.svg" style="height: 30px;width: 200px;"></a>
13+
814
---
915
---
1016

0 commit comments

Comments
 (0)