You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-1Lines changed: 20 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,7 @@ Boxo 🍌
20
20
-[Does Boxo == IPFS?](#does-boxo--ipfs)
21
21
-[Is everything related to IPFS in the Go ecosystem in this repo?](#is-everything-related-to-ipfs-in-the-go-ecosystem-in-this-repo)
22
22
-[Getting started](#getting-started)
23
+
-[Migrating to Boxo](#migrating-to-boxo)
23
24
-[Should I add my IPFS component to Boxo?](#should-i-add-my-ipfs-component-to-boxo)
24
25
-[Help](#help)
25
26
-[Governance and Access](#governance-and-access)
@@ -69,7 +70,7 @@ No. This repo houses some IPFS functionality written in Go that has been useful
69
70
70
71
### Is everything related to IPFS in the Go ecosystem in this repo?
71
72
72
-
No. Not everything related to IPFS is intended to be in Boxo. View it as a starter toolbox (potentially among multiple). If you’d like to build an IPFS implementation with Go, here are some tools you might want that are maintained by a group that has long term commitments to the IPFS project. There are certainly repos that others maintainer that aren't included here (e.g., ipfs/go-car) which are still useful to IPFS implementations. It's expected and fine for new IPFS functionality to be developed that won't be part of Boxo.
73
+
No. Not everything related to IPFS is intended to be in Boxo. View it as a starter toolbox (potentially among multiple). If you’d like to build an IPFS implementation with Go, here are some tools you might want that are maintained by a group that has long term commitments to the IPFS project. There are certainly repos that others maintainer that aren't included here (e.g., ipfs/go-car) which are still useful to IPFS implementations. It's expected and fine for new IPFS functionality to be developed that won't be part of Boxo.
73
74
74
75
### Why is the code coverage so bad?
75
76
@@ -78,6 +79,24 @@ The code coverage of this repo is not currently representative of the actual tes
78
79
## Getting started
79
80
See [examples](./examples/README.md).
80
81
82
+
If you are migrating to Boxo, see [Migrating to Boxo](#migrating-to-boxo).
83
+
84
+
## Migrating to Boxo
85
+
Many Go modules under github.com/ipfs have moved here. Boxo provides a tool to ease this migration, which does most of the work for you:
86
+
87
+
*`cd` into the root directory of your module (where the `go.mod` file is)
88
+
* Run: `go run github.com/ipfs/boxo/cmd/boxo-migrate@latest update-imports`
89
+
* This will upgrade your module to Boxo v0.8.0 and rewrite your import paths
90
+
* Run: `go run github.com/ipfs/boxo/cmd/boxo-migrate@latest check-dependencies`
91
+
* This will print unmaintained dependencies you still have
92
+
* These aren't necessarily an immediate problem, but you should eventually get them out of your dependency graph
93
+
94
+
This tool only upgrades your module to Boxo v0.8.0, to minimize backwards-incompatible changes. Depending on the versions of IPFS modules before the upgrade, your code may require additional changes to build.
95
+
96
+
We recommend upgrading to v0.8.0 first, and _then_ upgrading to the latest Boxo release.
97
+
98
+
If you encounter any challenges, please [open an issue](https://github.com/ipfs/boxo/issues/new/choose) and Boxo maintainers will help you.
99
+
81
100
## Should I add my IPFS component to Boxo?
82
101
We happily accept external contributions! However, Boxo maintains a high quality bar, so code accepted into Boxo must meet some minimum maintenance criteria:
0 commit comments