Skip to content
This repository was archived by the owner on Mar 5, 2026. It is now read-only.

Commit 232b87a

Browse files
ivankravetsme-no-dev
authored andcommitted
Add Installation section and instruction for @platformio (me-no-dev#293)
1 parent 6edc431 commit 232b87a

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ To use this library you might need to have the latest git versions of [ESP32](ht
1212

1313
## Table of contents
1414
- [ESPAsyncWebServer ](#espasyncwebserver-)
15+
- [Installation](#installation)
16+
- [Using PlatformIO](#using-platformio)
1517
- [Why should you care](#why-should-you-care)
1618
- [Important things to remember](#important-things-to-remember)
1719
- [Principles of operation](#principles-of-operation)
@@ -78,6 +80,33 @@ To use this library you might need to have the latest git versions of [ESP32](ht
7880
- [Setup global and class functions as request handlers](#setup-global-and-class-functions-as-request-handlers)
7981
- [Methods for controlling websocket connections](#methods-for-controlling-websocket-connections)
8082
- [Adding default headers to all responses](#adding-default-headers)
83+
84+
## Installation
85+
86+
### Using PlatformIO
87+
88+
[PlatformIO](http://platformio.org) is an open source ecosystem for IoT development with cross platform build system, library manager and full support for Espressif ESP8266/ESP32 development. It works on the popular host OS: Mac OS X, Windows, Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
89+
90+
1. Install [PlatformIO IDE](http://platformio.org/platformio-ide)
91+
2. Create new project using "PlatformIO Home > New Project"
92+
3. Update dev/platform to staging version:
93+
- [Instruction for Espressif 8266](http://docs.platformio.org/en/latest/platforms/espressif8266.html#using-arduino-framework-with-staging-version)
94+
- [Instruction for Espressif 32](http://docs.platformio.org/en/latest/platforms/espressif32.html#using-arduino-framework-with-staging-version)
95+
4. Add "ESP Async WebServer" to project using [Project Configuration File `platformio.ini`](http://docs.platformio.org/page/projectconf.html) and [lib_deps](http://docs.platformio.org/page/projectconf/section_env_library.html#lib-deps) option:
96+
```ini
97+
[env:myboard]
98+
platform = espressif...
99+
board = ...
100+
framework = arduino
101+
102+
# using the latest stable version
103+
lib_deps = ESP Async WebServer
104+
105+
# or using GIT Url (the latest development version)
106+
lib_deps = https://github.com/me-no-dev/ESPAsyncWebServer.git
107+
```
108+
5. Happy coding with PlatformIO!
109+
81110
## Why should you care
82111
- Using asynchronous network means that you can handle more than one connection at the same time
83112
- You are called once the request is ready and parsed

0 commit comments

Comments
 (0)