espressif / esptool-js

Javascript implementation of flasher tool for Espressif chips, running in web browser using WebSerial.
https://espressif.github.io/esptool-js/
Apache License 2.0
288 stars 108 forks source link

adding examples and usage in readme #85

Closed brianignacio5 closed 1 year ago

brianignacio5 commented 1 year ago

This PR is to relocate the example code to examples directory.

Fix #77

This package has different releases source code:

  1. bundle.js which can be used in CDNs
  2. lib/index.js which can be used for Javascript projects
  3. lib/index.ts which can be used in Typescript projects.

Basic API usage in README.md should be the same for former cases.

Please let me know your feedback about examples here. Maybe we can improve or make better minimal cases.

brianignacio5 commented 1 year ago

@balloob Could you also take a look here ?

igrr commented 1 year ago

Do we need to do anything for GitHub pages to be published correctly? (Looks like the index has been moved.)

brianignacio5 commented 1 year ago

You could try this merged in my fork https://brianignacio5.github.io/esptool-js/

@igrr @balloob @adwait-esp