README.md 1.43 KB
Newer Older
Jeromy's avatar
Jeromy committed
1 2 3
go-car (go!)
==================

Steven Allen's avatar
Steven Allen committed
4 5 6
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
[![](https://img.shields.io/badge/project-ipld-orange.svg?style=flat-square)](https://github.com/ipld/ipld)
[![](https://img.shields.io/badge/freenode-%23ipld-orange.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipld)
7
[![Go Reference](https://pkg.go.dev/badge/github.com/ipld/go-car.svg)](https://pkg.go.dev/github.com/ipld/go-car)
Steven Allen's avatar
Steven Allen committed
8
[![Coverage Status](https://codecov.io/gh/ipld/go-car/branch/master/graph/badge.svg)](https://codecov.io/gh/ipld/go-car/branch/master)
Jeromy's avatar
Jeromy committed
9

10
> A library to interact with merkledags stored as a single file
Jeromy's avatar
Jeromy committed
11

12
This is an implementation in Go of the [CAR spec](https://ipld.io/specs/transport/car/).
Jeromy's avatar
Jeromy committed
13

14
Note that there are two major module versions:
Jeromy's avatar
Jeromy committed
15

16 17 18
* [go-car/v2](v2/) is geared towards reading and writing CARv2 files, and also
  supports consuming CARv1 files and using CAR files as an IPFS blockstore.
* go-car v0, in the root directory, just supports reading and writing CARv1 files.
Jeromy's avatar
Jeromy committed
19

20 21 22 23 24
Most users should attempt to use v2, especially for new software.

## Maintainers

[Daniel Martí](https://github.com/mvdan) and [Masih Derkani](https://github.com/masih).
Jeromy's avatar
Jeromy committed
25 26 27 28 29 30 31 32 33

## Contribute

PRs are welcome!

Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

Steven Allen's avatar
Steven Allen committed
34
Apache-2.0/MIT © Protocol Labs