diff --git a/README.md b/README.md index f9bd67e..e0b0c3e 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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() { @@ -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 --output --package @@ -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 @@ -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 { @@ -181,7 +183,7 @@ import ( "context" "fmt" - "github.com/fragment-dev/fragment-go/queries" + "github.com/fragment-dev/fragment-go/v3/queries" ) func main() { @@ -212,7 +214,7 @@ import ( "fmt" "os" - "github.com/fragment-dev/fragment-go/queries" + "github.com/fragment-dev/fragment-go/v3/queries" ) func main() { @@ -251,7 +253,7 @@ import ( "fmt" "os" - "github.com/fragment-dev/fragment-go/queries" + "github.com/fragment-dev/fragment-go/v3/queries" ) func main() { @@ -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()` diff --git a/example/main.go b/example/main.go index ffe296e..121f897 100644 --- a/example/main.go +++ b/example/main.go @@ -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() { diff --git a/go.mod b/go.mod index 1cccf02..f11ae85 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/fragment-dev/fragment-go +module github.com/fragment-dev/fragment-go/v3 go 1.22.5