Skip to content

Commit

Permalink
change(readme): update client-go & main README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgechato committed Nov 4, 2023
1 parent d4e7f04 commit cb0ee5c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 7 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@

## Release

> **Warning:** Make sure you merged the changelog_* branch into main before releasing
```bash
# Make sure you are in main branch and you have the latest changes
$ git switch main && git fetch --tags

$ make plugin # if you need to build the plugins
$ make changelog # will generate a new tag and update the changelog

$ make release # will create a new release in the client repositories
# if you want to release for a specific client you can do
$ make release/go

# if you want to release for a specific version you can do
$ NEXT_VERSION=vx.x.x make release
```
17 changes: 11 additions & 6 deletions scripts/go/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Client-go

> **Warning:** This repository is automatically generated. Please don't make any changes here.
This repository contains the client libraries for the [areugoh](https://github.com/areugoh) services.
It's **automatically generated** from the [proto](https://github.com/areugoh/proto) repository.

## Installation

> **Note:** You can see the latest version [here](https://github.com/areugoh/client-go/tags).
Expand All @@ -21,14 +26,14 @@ import (
"fmt"
"log"

# inporting greenspace namespace as an example
pb "github.com/areugoh/client-go/greenspace/api/v1"
// inporting greenspace namespace as an example
pb "github.com/areugoh/client-go/greenspace/api/v1"
)

func main() {
# ... create client ...
// ... create client ...

# create a new request
// create a new request
req := &pb.CoastRequest{
Location: &pb.LocationResponse{
Longitude: 35.4729335,
Expand All @@ -37,13 +42,13 @@ func main() {
},
}

# send the request to the server
// send the request to the server
res, err := client.GetCoast(ctx, req)
if err != nil {
log.Fatalf("Failed to create greenspace: %v", err)
}

# print the response
// print the response
fmt.Println(res)
}
```

0 comments on commit cb0ee5c

Please sign in to comment.