Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify ipld/car relatioship with ipld/go-car #244

Closed
wants to merge 3 commits into from
+17 −10
Closed

Clarify ipld/car relatioship with ipld/go-car #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a2ff52
Clarify ipld/car relatioship with ipld/go-car
BigLep Mar 30, 2023
3c9aaec
Update ipld/car readme
BigLep Mar 30, 2023
1fcb4ff
Update README.md
BigLep Apr 6, 2023
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
5 changes: 4 additions & 1 deletion cmd/boxo-migrate/internal/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ var DefaultConfig = Config{
"github.com/ipfs/go-ipfs-routing": "github.com/ipfs/boxo/routing",
"github.com/ipfs/go-ipfs-exchange-interface": "github.com/ipfs/boxo/exchange",
"github.com/ipfs/go-merkledag": "github.com/ipfs/boxo/ipld/merkledag",
"github.com/ipld/go-car": "github.com/ipfs/boxo/ipld/car",
// By default, users can/should keep using ipld/go-car.
// Updating ipld/go-car was useful for other repos that are also maintained by Boxo maintainers like Kubo
// More info is in https://github.com/ipfs/boxo/issues/218
// "github.com/ipld/go-car": "github.com/ipfs/boxo/ipld/car",

// Pre Boxo rename
"github.com/ipfs/go-libipfs/gateway": "github.com/ipfs/boxo/gateway",
Expand Down
22 changes: 13 additions & 9 deletions ipld/car/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
go-car (go!)
==================
# ❗ About CAR libraries written in go
As of 202303, this is a copy of [`ipld/go-car`](github.com/ipld/go-car).
`ipld/go-car` is a full-featured car library that is actively maintained.
Boxo has smaller car needs and will be will be refactored and thinned out in the future.
Boxo can't depend on `ipld/go-car` because it would cause `ipld/go-car` to have dependency on Boxo,
and `ipld/go-car` maintainers want to be able to develop indepdently.

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
[![Go Reference](https://pkg.go.dev/badge/github.com/boxo/ipld/car.svg)](https://pkg.go.dev/github.com/boxo/ipld/car)
***A user can always use `ipld/go-car` in conjuection with `boxo/ipld/car`.***
Please use `ipld/go-car` as needed!

More details and discussion are [here](https://github.com/ipfs/boxo/issues/218).

---

# About this module
> Work with car (Content addressed ARchive) files!

This is a Golang implementation of the [CAR specifications](https://ipld.io/specs/transport/car/), both [CARv1](https://ipld.io/specs/transport/car/carv1/) and [CARv2](https://ipld.io/specs/transport/car/carv2/).
Expand All @@ -16,11 +25,6 @@ As a format, there are two major module versions:

Most users should use v2, especially for new software, since the v2 API transparently supports both CAR formats.

# **Unstable**

This package will be refactored and thinned out soon. You can find an
implementation that supports indexes and go-ipld-prime there at [`ipld/go-car`](github.com/ipld/go-car).

## Usage / Installation

This repository provides a `car` binary that can be used for creating, extracting, and working with car files.
Expand Down