Skip to content

Commit

Permalink
update package godocs and root level README for v2
Browse files Browse the repository at this point in the history
While at it, make v2's license a symlink, so the two stay in sync.
The reason we want the v2 module to have its own license is so that its
module zip includes the file as well.

Besides mentioning v0 and v2, the root README now also links to pkgsite
and lists Masih and myself as default maintainers, given that we're the
ones that did major work on this library last.

Fixes #124.
Fixes #179.
  • Loading branch information
mvdan authored and masih committed Aug 4, 2021
1 parent 3752fdb commit 61cfb4d
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 237 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,24 @@ go-car (go!)
[![](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)
[![Go Reference](https://pkg.go.dev/badge/github.com/ipld/go-car.svg)](https://pkg.go.dev/github.com/ipld/go-car)
[![Coverage Status](https://codecov.io/gh/ipld/go-car/branch/master/graph/badge.svg)](https://codecov.io/gh/ipld/go-car/branch/master)

> go-car is a simple way of packing a merkledag into a single file
> A library to interact with merkledags stored as a single file
This is an implementation in Go of the [CAR spec](https://ipld.io/specs/transport/car/).

## Table of Contents
Note that there are two major module versions:

- [Install](#install)
- [Contribute](#contribute)
- [License](#license)
* [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.

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).

## Contribute

Expand Down
229 changes: 0 additions & 229 deletions v2/LICENSE.md

This file was deleted.

1 change: 1 addition & 0 deletions v2/LICENSE.md
2 changes: 1 addition & 1 deletion v2/blockstore/doc.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// package blockstore implements IPFS blockstore interface backed by a CAR file.
// package blockstore implements the IPFS blockstore interface backed by a CAR file.
// This package provides two flavours of blockstore: ReadOnly and ReadWrite.
//
// The ReadOnly blockstore provides a read-only random access from a given data payload either in
Expand Down
9 changes: 7 additions & 2 deletions v2/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
// Package car represents the CARv2 implementation.
// TODO add CARv2 byte structure here.
// Package car allows inspecting and reading CAR files,
// described at https://ipld.io/specs/transport/car/.
// The entire library is geared towards the CARv2 spec,
// but many of the APIs consuming CAR files also accept CARv1.
//
// The blockstore sub-package contains an implementation of the
// go-ipfs-blockstore interface.
package car

0 comments on commit 61cfb4d

Please sign in to comment.