From f337c24ff7ed59369d77bd4eff9b1d86ca8d23cb Mon Sep 17 00:00:00 2001 From: SP Singh Date: Mon, 18 Oct 2021 17:45:59 +1100 Subject: [PATCH] Updated library instructions --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e4239c7..198c6a8 100644 --- a/README.md +++ b/README.md @@ -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. @@ -209,7 +207,7 @@ 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 ``` @@ -217,7 +215,9 @@ 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 @@ -225,12 +225,6 @@ 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