From fcb46dd1734b52dc63ed9f2e8add71eeef53368e Mon Sep 17 00:00:00 2001 From: abansal88 Date: Sun, 29 Mar 2020 14:13:28 -0700 Subject: [PATCH] updating readme --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7920972..df66943 100644 --- a/README.md +++ b/README.md @@ -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 --text **: 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... \ No newline at end of file