Merge pull request #177 from BuxOrg/feat/BUX-434/ChangeReadme

BUX-434/Change Readme

README.md

@@ -207,6 +207,31 @@ Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
 
 <br/>
 
+## Usage
+
+
+```
+// http example
+func main() {
+
+	// Generate keys
+	keys, _ := xpriv.Generate()
+
+	// Create a client
+	client, _ := buxclient.New(
+        buxclient.WithXPriv(keys.XPriv()),
+        buxclient.WithHTTP("localhost:3001"),
+        buxclient.WithSignRequest(true))
+    
+    fmt.Println(client.IsSignRequest())
+}
+
+```
+
+Checkout all the [examples](examples)!
+
+<br/>
+
 ## Contributing
 All kinds of contributions are welcome!
 <br/>

examples/http/http.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"fmt"
 	"github.com/BuxOrg/go-buxclient"
 	"github.com/BuxOrg/go-buxclient/xpriv"
 )
@@ -11,9 +12,10 @@ func main() {
 	keys, _ := xpriv.Generate()
 
 	// Create a client
-	_, _ = buxclient.New(
+	client, _ := buxclient.New(
 		buxclient.WithXPriv(keys.XPriv()),
 		buxclient.WithHTTP("localhost:3001"),
 		buxclient.WithSignRequest(true),
 	)
+	fmt.Println(client.IsSignRequest())
 }

examples/register_xpub/register_xpub.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"context"
+	"fmt"
 	buxmodels "github.com/BuxOrg/bux-models"
 	"github.com/BuxOrg/go-buxclient"
 	"github.com/BuxOrg/go-buxclient/xpriv"
@@ -14,12 +15,22 @@ func main() {
 	// Create a client
 	buxClient, _ := buxclient.New(
 		buxclient.WithXPriv(keys.XPriv()),
-		buxclient.WithHTTP("localhost:3001"),
+		buxclient.WithHTTP("localhost:3003/v1"),
 		buxclient.WithSignRequest(true),
 	)
 
+	ctx := context.Background()
+
 	_ = buxClient.NewXpub(
-		context.Background(), keys.XPub().String(), &buxmodels.Metadata{"example_field": "example_data"},
+		ctx, keys.XPub().String(), &buxmodels.Metadata{"example_field": "example_data"},
 	)
 
+	xpubKey, err := buxClient.GetXPub(ctx)
+
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	fmt.Println(xpubKey)
+
 }