Skip to content

Commit

Permalink
docs: add some text to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maythiwat committed Jun 19, 2022
1 parent deb7928 commit a11e1b0
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# node-blynk
✨ Node.js Client for Blynk (Legacy) Mobile App Protocol

## Why?
I just want to register a new account on self-hosted server, but Blynk (Legacy) app don't let me to do that

and I just saw that Blynk (Legacy) app will be removed from the store on this June 30th,

so I decided to open source this project, That's it! 🤷‍♂️

![aru-panik](https://user-images.githubusercontent.com/23092256/174468961-5cda69e7-a4f5-46fe-a458-12efc6f64880.png)

## Features
- Login/Register Account
- Get Energy
- Get Devices in Dashboard
- Load Profile
- Hardware Command (WIP)

## Usage
```ts
Expand Down Expand Up @@ -33,6 +43,10 @@ await blynk.getEnergy() // Returns energy amount (e.g. 10000)

- [Login Command Logic](https://github.com/blynkkk/blynk-server/blob/master/server/tcp-app-server/src/main/java/cc/blynk/server/application/handlers/main/auth/MobileLoginHandler.java)

- [Hardware Command Logic](https://github.com/blynkkk/blynk-server/blob/master/server/tcp-app-server/src/main/java/cc/blynk/server/application/handlers/main/logic/MobileHardwareLogic.java)

- [Hardware Pin Types](https://github.com/blynkkk/blynk-server/blob/master/server/core/src/main/java/cc/blynk/server/core/model/enums/PinType.java)

- [Test App Client](https://github.com/blynkkk/blynk-server/blob/master/integration-tests/src/test/java/cc/blynk/integration/model/tcp/TestAppClient.java)

- [ilcato/blynk-app-client](https://github.com/ilcato/blynk-app-client/blob/master/index.js)
Expand All @@ -42,4 +56,4 @@ This project is MIT licensed (see [LICENSE.md](LICENSE.md))

Not affiliated with Blynk Inc. in any way,

Trademarks belongs to their respective owner.
Trademarks belongs to their respective owner.

0 comments on commit a11e1b0

Please sign in to comment.