Skip to content

Commit

Permalink
Add available functions list
Browse files Browse the repository at this point in the history
  • Loading branch information
danielcardeenas authored Jun 13, 2019
1 parent 3cb3a06 commit 24664f9
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,22 @@ function start(client: Whatsapp) {
```

###### After executing `create()` function, **sulla** will create an instance of whatsapp web. If you are not logged in, it will print a QR code in the [terminal](https://i.imgur.com/g8QvERI.png). Scan it with your phone and you are ready to go!

###### sulla will remember the session so there is no need to authenticate everytime.

### Functions list
| Function | Description | Implemented |
|----------------------------------- |------------- |------------- |
| Receive message | | βœ… |
| Send text | | βœ… |
| Get contacts | | βœ… |
| Get chats | | βœ… |
| Get groups | | βœ… |
| Get group members | | βœ… |
| Send contact | | βœ… |
| Get contact detail | | βœ… |
| Send media (image, audio, doc) | | |
| Send stickers | | |
| Decrypt media (image, audio, doc) | | |

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Expand Down

0 comments on commit 24664f9

Please sign in to comment.