Skip to content

Commit

Permalink
Updated library instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
SP Singh committed Oct 18, 2021
1 parent 0bb0f8d commit f337c24
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


# SMSGlobal Go SDK

The official [SMSGlobal](https://www.smsglobal.com?utm_source=dev&utm_medium=github&utm_campaign=go_sdk) Go client library.
Expand Down Expand Up @@ -209,28 +207,24 @@ Checkout [examples](examples) folder. It contains an example of each method avai
### Installing GoDoc for Go v1.1.4
Once Go v1.14 has been installed, execute the following commands to install GoDoc from smsglobal-go project's root directory

```shell script
```sh
GOBIN=`pwd`/bin && mkdir bin && go get -u golang.org/x/tools/cmd/godoc
```

Make sure you use the godoc tool that is installed in smsglobal-go/bin directory

### Running documentation server

```sh
./dev-bin/docs
```

Navigate here to see the documentation in your local browser:
http://localhost:6060/pkg/github.com/smsglobal/smsglobal-go

### Running Tests
To run unit tests execute the following command

```shell script
```sh
./dev-bin/test
```



### TODO List
[ ] Write how to use instructions
[ ] Document all methods as per go coding standards and generate godoc

0 comments on commit f337c24

Please sign in to comment.