From f9a1c81464ce53d227f76ba439ea8dc2a9c9c9b9 Mon Sep 17 00:00:00 2001 From: Mathieu Carbou Date: Fri, 19 Apr 2024 23:54:56 +0200 Subject: [PATCH] doc update --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9c7228b..f7700a8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ # AsyncTCP -![Build Status](https://github.com/mathieucarbou/AsyncTCP/actions/workflows/push.yml/badge.svg) + +[![License: LGPL 3.0](https://img.shields.io/badge/License-LGPL%203.0-yellow.svg)](https://opensource.org/license/lgpl-3-0/) +[![Continuous Integration](https://github.com/mathieucarbou/AsyncTCP/actions/workflows/push.yml/badge.svg)](https://github.com/mathieucarbou/AsyncTCP/actions/workflows/push.yml) +[![PlatformIO Registry](https://badges.registry.platformio.org/packages/mathieucarbou/library/Async%20TCP.svg)](https://registry.platformio.org/libraries/mathieucarbou/Async%20TCP) + A fork of the [AsyncTCP](https://github.com/me-no-dev/AsyncTCP) library by [@me-no-dev](https://github.com/me-no-dev) for [ESPHome](https://esphome.io). ### Async TCP Library for ESP32 Arduino This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP32 MCUs. -This library is the base for [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) +This library is the base for [ESPAsyncWebServer](https://github.com/mathieucarbou/ESPAsyncWebServer) ## AsyncClient and AsyncServer The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use. @@ -16,3 +20,5 @@ The base classes on which everything else is built. They expose all possible sce - All improvements from [ESPHome fork](https://github.com/esphome/AsyncTCP) - Reverted back `library.properties` for Arduino IDE users - Arduino 3 / ESP-IDF 5 compatibility +- Changed lib name: `AsyncTCP` -> `Async TCP` +- Point to `mathieucarbou/Async TCP @ ^3.0.0`