Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
abansal88 committed Mar 29, 2020
1 parent 9341007 commit fcb46dd
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
# go-whatsapp-client
This repo builds over Rhymen/go-whatsapp to provide a cli for whatsapp.

# Building
The Makefile consists of rules to help you build the project.

To build the project including the linters and fmt:\
**make all**

To only build the binary:\
**make build**

To clean:\
**make clean**

The dependencies are vendored in the repository. Due to difference in how go 1.13 and go 1.14 treats vendor directory, there are two ways to run depending on the version:\
**go 1.13** : GO111MODULE=off go build\
**go 1.14** : go build\
Make sure you make the changes in the Makefile if you are using go 1.13. The current file is amied for go 1.14.

# Running
Current commands installed:\
**1. whatsapp-cli login**: Logs you in\
**2. whatsapp-cli logout**: Logs you out\
**3. whatsapp-cli sendText --to <phone_number> --text <text_message>**: Sends the text_message to the phone_number

The dependencies will be vendored in the repository. Due to difference in how go 1.13 and go 1.14 treats vendor directory, there are two ways to run depending on the version:
**go 1.13** : GO111MODULE=off go run main.go
**go 1.14** : go run main.go
**NOTE** : More coming soon...

0 comments on commit fcb46dd

Please sign in to comment.