Skip to content

feat: add demo and usage guide for eufy-security-client#717

Open
rasmusbe wants to merge 1 commit intobropat:masterfrom
rasmusbe:docs-and-demo
Open

feat: add demo and usage guide for eufy-security-client#717
rasmusbe wants to merge 1 commit intobropat:masterfrom
rasmusbe:docs-and-demo

Conversation

@rasmusbe
Copy link
Copy Markdown

@rasmusbe rasmusbe commented Dec 2, 2025

Create a demo application for the eufy-security-client showcasing its main features: device listing, real-time events, 2FA handling, and interactive console output. Implement .env configuration for sensitive credentials and set up essential dependencies and commands in package.json. Extend documentation with a comprehensive usage guide, including installation, authentication, device interaction, event handling, and error management. These changes enhance the library's usability and provide clear guidance for users to integrate the library into their projects effectively.

Solves #1

Create a demo application for the eufy-security-client showcasing its
main features: device listing, real-time events, 2FA handling, and
interactive console output. Implement .env configuration for sensitive
credentials and set up essential dependencies and commands in
package.json. Extend documentation with a comprehensive usage guide,
including installation, authentication, device interaction, event
handling, and error management. These changes enhance the library's
usability and provide clear guidance for users to integrate the
library into their projects effectively.
@rasmusbe rasmusbe mentioned this pull request Dec 3, 2025
@max246 max246 self-requested a review December 9, 2025 18:31
@max246
Copy link
Copy Markdown
Collaborator

max246 commented Dec 9, 2025

Thank you, will have a look in the next few days to ensure everything is good.
We still need to add documentation how to add new cameras and where to find info to then add all the bits.

It is a good start!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants