Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexLynd committed Nov 29, 2023
1 parent 059b220 commit 127f741
Showing 1 changed file with 4 additions and 18 deletions.
22 changes: 4 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
# This package is deprecated. Use [esptool-js](https://github.com/espressif/esptool-js/) instead.
# DevKitty Web Flasher

# ESP Web Flasher
This project is a fork of [Adafruit's WebSerial ESPTool.](https://github.com/adafruit/Adafruit_WebSerial_ESPTool)

JavaScript package to install firmware on ESP devices via the browser using WebSerial.

_This project is a collaboration between [Adafruit](https://www.adafruit.com/) and [Nabu Casa](https://www.nabucasa.com/)._

## Used by

- [Adafruit WipperSnapper](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper)
- [ESP Web Tools](https://github.com/esphome/esp-web-tools), the one click button to install your ESP devices via the browser.
Credit to [Melissa LeBlanc-Williams](https://github.com/makermelissa), and [Nabu Casa](https://www.nabucasa.com) for fostering the original project.

## Local development

- Clone this repository.
- Install dependencies with `npm`
- Run `script/develop`
- Open http://localhost:5004/

## Origin

This project started as a fork of [Adafruit WebSerial ESPTool](https://github.com/adafruit/Adafruit_WebSerial_ESPTool) written by
[Melissa LeBlanc-Williams](https://github.com/makermelissa) in June 2021. At the time fo the fork, the original repository was a single-use website. This fork converted the code into a reusable package and published it to NPM.

In March 2022 [Nabu Casa](https://www.nabucasa.com) took over maintenance from Adafruit and this fork became the main code base.
- Open `http://localhost:5004/`

0 comments on commit 127f741

Please sign in to comment.