Merge pull request #13 from ESP32Async/doc

(doc) Documentation update

README.md

@@ -6,50 +6,34 @@
 [![Continuous Integration](https://github.com/ESP32Async/AsyncTCP/actions/workflows/ci.yml/badge.svg)](https://github.com/ESP32Async/AsyncTCP/actions/workflows/ci.yml)
 [![PlatformIO Registry](https://badges.registry.platformio.org/packages/ESP32Async/library/AsyncTCP.svg)](https://registry.platformio.org/libraries/ESP32Async/AsyncTCP)
 
-Project moved to [ESP32Async](https://github.com/ESP32Async) organization at [https://github.com/ESP32Async/AsyncTCP](https://github.com/ESP32Async/AsyncTCP)
-
 Discord Server: [https://discord.gg/X7zpGdyUcY](https://discord.gg/X7zpGdyUcY)
 
-Please see the new links:
-
-- `ESP32Async/ESPAsyncWebServer` (ESP32, ESP8266, RP2040)
-- `ESP32Async/AsyncTCP` (ESP32)
-- `ESP32Async/ESPAsyncTCP` (ESP8266)
-- `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip` (AsyncTCP alternative for ESP32)
-- `khoih-prog/AsyncTCP_RP2040W` (RP2040)
-
-### Async TCP Library for ESP32 Arduino
+## 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/ESP32Async/ESPAsyncWebServer)
 
+## How to install
+
+The library can be downloaded from the releases page at [https://github.com/ESP32Async/AsyncTCP/releases](https://github.com/ESP32Async/AsyncTCP/releases).
+
+It is also deployed in these registries:
+
+- Arduino Library Registry: [https://github.com/arduino/library-registry](https://github.com/arduino/library-registry)
+
+- ESP Component Registry [https://components.espressif.com/components/esp32async/asynctcp/](https://components.espressif.com/components/esp32async/asynctcp/)
+
+- PlatformIO Registry: [https://registry.platformio.org/libraries/esp32async/AsyncTCP](https://registry.platformio.org/libraries/esp32async/AsyncTCP)
+
+  - Use: `lib_deps=ESP32Async/AsyncTCP` to point to latest version
+  - Use: `lib_deps=ESP32Async/AsyncTCP @ ^<x.y.z>` to point to latest version with the same major version
+  - Use: `lib_deps=ESP32Async/AsyncTCP @ <x.y.z>` to always point to the same version (reproductible build)
+
 ## 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.
 
-## Changes
-
-- `library.properties` for Arduino IDE users
-- Add `CONFIG_ASYNC_TCP_MAX_ACK_TIME`
-- Add `CONFIG_ASYNC_TCP_PRIORITY`
-- Add `CONFIG_ASYNC_TCP_QUEUE_SIZE`
-- Add `setKeepAlive()`
-- Arduino 3 / ESP-IDF 5 compatibility
-- Better CI
-- Better example
-- Customizable macros
-- Fix for "Required to lock TCPIP core functionality". Ref: https://github.com/ESP32Async/AsyncTCP/issues/27 and https://github.com/espressif/arduino-esp32/issues/10526
-- Fix for "ack timeout 4" client disconnects.
-- Fix from https://github.com/me-no-dev/AsyncTCP/pull/173 (partially applied)
-- Fix from https://github.com/me-no-dev/AsyncTCP/pull/184
-- IPv6
-- LIBRETINY support
-- LibreTuya
-- Reduce logging of non critical messages
-- Use IPADDR6_INIT() macro to set connecting IPv6 address
-- xTaskCreateUniversal function
-
 ## Important recommendations
 
 Most of the crashes are caused by improper configuration of the library for the project.
@@ -64,3 +48,8 @@ I personally use the following configuration in my projects:
   -D CONFIG_ASYNC_TCP_RUNNING_CORE=1 // force async_tcp task to be on same core as the app (default is core 0)
   -D CONFIG_ASYNC_TCP_STACK_SIZE=4096 // reduce the stack size (default is 16K)
 ```
+
+## Compatibility
+
+- ESP32
+- Arduino Core 2.x and 3.x