Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

[Fragment](https://fragment.dev) is the Ledger API for engineers that move money. Stop wrangling payment tables, debugging balance errors, and hacking together data pipelines. Start shipping the features that make a difference.

> We've upgraded the module import path to `github.com/fragment-dev/fragment-go/v3`. The `github.com/fragment-dev/fragment-go` module is no longer supported. Update your imports to use `/v3` to get the latest version. See the [Upgrading SDK Versions](#upgrading-sdk-versions) section for details.

## Installation

This library requires Go 1.20+.

``` shell
go get -u github.com/fragment-dev/fragment-go
go get -u github.com/fragment-dev/fragment-go/v3
```

## Usage
Expand All @@ -20,8 +22,8 @@ import (
"fmt"
"os"

"github.com/fragment-dev/fragment-go/client"
"github.com/fragment-dev/fragment-go/queries"
"github.com/fragment-dev/fragment-go/v3/client"
"github.com/fragment-dev/fragment-go/v3/queries"
)

func main() {
Expand Down Expand Up @@ -60,7 +62,7 @@ We appreciate feedback; please open an [issue](https://github.com/fragment-dev/f
While the SDK comes with predefined GraphQL queries, you may want to customize these queries for your product. In order to do that, run:

``` shell
go run github.com/fragment-dev/fragment-go \
go run github.com/fragment-dev/fragment-go/v3 \
--input <path-to-your-graphql-queries-file.graphql>
--output <path-to-the-output.go>
--package <package-name>
Expand All @@ -87,7 +89,7 @@ query GetLatestSchema($key: SafeString!) {
Run the SDK codegen to generate the code for your GraphQL query.

``` shell
go run github.com/fragment-dev/fragment-go \
go run github.com/fragment-dev/fragment-go/v3 \
--input queries.graphql
--output queries.go
--package main
Expand Down Expand Up @@ -131,7 +133,7 @@ import (
"encoding/json"
"fmt"

"github.com/fragment-dev/fragment-go/queries"
"github.com/fragment-dev/fragment-go/v3/queries"
)

type UserFundsAccountParameters struct {
Expand Down Expand Up @@ -181,7 +183,7 @@ import (
"context"
"fmt"

"github.com/fragment-dev/fragment-go/queries"
"github.com/fragment-dev/fragment-go/v3/queries"
)

func main() {
Expand Down Expand Up @@ -212,7 +214,7 @@ import (
"fmt"
"os"

"github.com/fragment-dev/fragment-go/queries"
"github.com/fragment-dev/fragment-go/v3/queries"
)

func main() {
Expand Down Expand Up @@ -251,7 +253,7 @@ import (
"fmt"
"os"

"github.com/fragment-dev/fragment-go/queries"
"github.com/fragment-dev/fragment-go/v3/queries"
)

func main() {
Expand All @@ -269,6 +271,9 @@ func main() {
```

## Upgrading SDK Versions
### Changes in v3.1.0
- Module import path updated to `/v3`: Update all imports from `github.com/fragment-dev/fragment-go` to `github.com/fragment-dev/fragment-go/v3`

### Changes from v2.0.0 to v3.0.0

- Removed `AuthenticatedContext` and replaced it with `client.NewClient()`
Expand Down
4 changes: 2 additions & 2 deletions example/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import (
"fmt"
"os"

"github.com/fragment-dev/fragment-go/client"
"github.com/fragment-dev/fragment-go/queries"
"github.com/fragment-dev/fragment-go/v3/client"
"github.com/fragment-dev/fragment-go/v3/queries"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/fragment-dev/fragment-go
module github.com/fragment-dev/fragment-go/v3

go 1.22.5

Expand Down
Loading