Skip to content

Commit

Permalink
Remove note, use own version now
Browse files Browse the repository at this point in the history
  • Loading branch information
danielcardeenas committed Jan 23, 2020
1 parent 062ba21 commit 198fb04
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,12 @@
[![Maintainability](https://api.codeclimate.com/v1/badges/4cef2f41fd607c4c7094/maintainability)](https://codeclimate.com/github/danielcardeenas/sulla/maintainability)
[![Greenkeeper badge](https://badges.greenkeeper.io/danielcardeenas/sulla.svg)](https://greenkeeper.io/)

# Note
Currently fixing this package. Please take a look at smashah branched version:
[sulla-hotfix](https://github.com/smashah/sulla)

# sulla

> Sulla is a javascript library which provides a high-level API control to Whatsapp so it can be configured to automatize resposes or any data that goes trough Whatsapp effortlessly.
> Sulla is a javascript library which provides a high-level API control to Whatsapp so it can be configured to automatize resposes or any data that goes trough Whatsapp effortlessly.
>
> It is built using [puppeteer](https://github.com/GoogleChrome/puppeteer) and based on [this python wrapper](https://github.com/mukulhase/WebWhatsapp-Wrapper)

## Installation

```bash
Expand All @@ -37,25 +32,29 @@ function start(client) {
```

###### 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) | | |

| 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.

## License

[MIT](https://choosealicense.com/licenses/mit/)

0 comments on commit 198fb04

Please sign in to comment.