From 5c21cf0ce95d7c2710d5bb5dd58e2871c0fbc7bb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Pedro?=
 <92101826+PedrobyJoao@users.noreply.github.com>
Date: Tue, 28 Mar 2023 07:38:24 -0300
Subject: [PATCH] docs: adding example of connection and pinning to README
 (#173)

Co-authored-by: JPexplorer <jpexplorer@pop-os.localdomain>


This commit was moved from ipfs/go-ipfs-http-client@b0de2b028e6ef03d4dba3ed105641ad299d4f7be
---
 client/httpapi/README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/client/httpapi/README.md b/client/httpapi/README.md
index d3e14ac3f..da25f24fe 100644
--- a/client/httpapi/README.md
+++ b/client/httpapi/README.md
@@ -17,6 +17,41 @@ greatest features, please use _this_ package.
 
 https://godoc.org/github.com/ipfs/go-ipfs-http-api
 
+### Example
+
+Pin file on your local IPFS node based on its CID:
+
+```go
+package main
+
+import (
+    "context"
+    "fmt"
+
+    ipfsClient "github.com/ipfs/go-ipfs-http-client"
+    path "github.com/ipfs/interface-go-ipfs-core/path"
+)
+
+func main() {
+    // "Connect" to local node
+    node, err := ipfsClient.NewLocalApi()
+    if err != nil {
+        fmt.Printf(err)
+        return
+    }
+    // Pin a given file by its CID
+    ctx := context.Background()
+    cid := "bafkreidtuosuw37f5xmn65b3ksdiikajy7pwjjslzj2lxxz2vc4wdy3zku"
+    p := path.New(cid)
+    err = node.Pin().Add(ctx, p)
+    if err != nil {
+    	fmt.Printf(err)
+        return
+    }
+    return
+}
+```
+
 ## Contribute
 
 Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/go-ipfs-http-api/issues)!