update documentation

[brianignacio5]

Description

Update readme to show how to use this npm package.

This pull request significantly improves the README.md by providing a comprehensive and beginner-friendly usage guide for esptool-js. The documentation now covers installation, basic setup, serial port access, flashing firmware, reading and erasing flash, custom reset strategies, and includes a full example. Additionally, references and instructions have been updated for clarity and consistency.

Documentation enhancements:

• Added a prominent link to the full API documentation at the top of the README for easy access.
• Expanded the usage section into detailed, step-by-step guides covering installation, setup, connecting to devices, flashing firmware, reading/erasing flash, and advanced reset strategies, including code examples for each step.
• Provided a complete example workflow demonstrating how to use esptool-js in a real application, from requesting a serial port to flashing and resetting the device.
• Clarified how to implement and use custom terminal interfaces by detailing the IEspLoaderTerminal interface and updating the example.

Consistency and reference updates:

• Updated references to the "Usage" section to point to the new "Installation" section, ensuring instructions remain accurate after the documentation restructure.

Related

Fixes #207
Fixes #233

Testing

Documentation changes.

Checklist

Before submitting a Pull Request, please ensure the following:

• 🚨 This PR does not introduce breaking changes.
• All CI checks (GH Actions) pass.
• Documentation is updated as needed.
• Tests are updated or added as necessary.
• Code is well-commented, especially in complex areas.
• Git history is clean — commits are squashed to the minimum necessary.

[github-actions]

Download the artifacts for this pull request:

• esptool-js-0.5.7.tgz.zip