From 4644ac7c3356913feb3e48c950ca4f6c2623a188 Mon Sep 17 00:00:00 2001 From: aloknerurkar Date: Tue, 2 May 2023 10:55:14 +0530 Subject: [PATCH 1/3] Create README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bacfd72 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# go-libp2p-genrpc +Generics based RPC framework using libp2p + +`go-libp2p-genrpc` is a small library which provides a type-safe API to write go functions as RPCs over libp2p transport. + +The goal was to see if we can provide similar functionality as `go-libp2p-gorpc` but using generics in a type-safe manner. The result is a slightly different API which is more verbose. Additional functionality like writing middlewares is also possible. + +## Install +This module can be installed with `go get`: +``` +> go get github.com/plexsysio/go-libp2p-genrpc +``` + +## Usage +Check [docs](https://pkg.go.dev/github.com/plexsysio/go-libp2p-genrpc). + +There are also some [examples](https://github.com/plexsysio/go-libp2p-genrpc/tree/main/examples). From 2eb93f7112a61c7ac8cd879a95d172d13b61df51 Mon Sep 17 00:00:00 2001 From: aloknerurkar Date: Tue, 2 May 2023 11:01:51 +0530 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bacfd72..4297411 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# go-libp2p-genrpc +# go-libp2p-genrpc [![Go](https://github.com/plexsysio/go-libp2p-genrpc/workflows/Go/badge.svg)](https://github.com/plexsysio/go-libp2p-genrpc/actions) [![Go Reference](https://pkg.go.dev/badge/github.com/plexsysio/go-libp2p-genrpc.svg)](https://pkg.go.dev/github.com/plexsysio/go-libp2p-genrpc) [![Coverage Status](https://coveralls.io/repos/github/plexsysio/go-libp2p-genrpc/badge.svg?branch=main)](https://coveralls.io/github/plexsysio/go-libp2p-genrpc?branch=main) Generics based RPC framework using libp2p `go-libp2p-genrpc` is a small library which provides a type-safe API to write go functions as RPCs over libp2p transport. From b45d5a198ea16ba2abd1246c874a07533584cb3b Mon Sep 17 00:00:00 2001 From: alok Date: Tue, 2 May 2023 11:05:25 +0530 Subject: [PATCH 3/3] chore: add coveralls --- .github/workflows/go.yml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index f81d129..2da0188 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -26,4 +26,11 @@ jobs: run: go build -v ./... - name: Test - run: go test -v -race ./... + run: go test -v -race -coverprofile=cover.out ./... + + - name: Coveralls + uses: shogo82148/actions-goveralls@v1 + with: + path-to-profile: cover.out + env: + COVERALLS_TOKEN: ${{ secrets.COVERALLS_TOKEN }}