From 85f0751677fa4115a44455d16ae1d060bc078104 Mon Sep 17 00:00:00 2001
From: Will <will.scott@protocol.ai>
Date: Mon, 1 Nov 2021 02:22:43 -0700
Subject: [PATCH] Add a barebones readme to the car CLI (#262)

---
 README.md         |  2 +-
 cmd/car/README.md | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+), 1 deletion(-)
 create mode 100644 cmd/car/README.md

diff --git a/README.md b/README.md
index 7ccf7cca..0f215799 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@ 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)
+[![](https://img.shields.io/badge/matrix-%23ipld-blue.svg?style=flat-square)](https://matrix.to/#/#ipld:ipfs.io)
 [![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)
 
diff --git a/cmd/car/README.md b/cmd/car/README.md
new file mode 100644
index 00000000..f3825f0d
--- /dev/null
+++ b/cmd/car/README.md
@@ -0,0 +1,33 @@
+car - The CLI tool
+==================
+
+[![](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/matrix-%23ipld-blue.svg?style=flat-square)](https://matrix.to/#/#ipld:ipfs.io)
+
+> A CLI to interact with car files
+
+## Usage
+
+```
+USAGE:
+   car [global options] command [command options] [arguments...]
+
+COMMANDS:
+   create, c      Create a car file
+   detach-index   Detach an index to a detached file
+   filter, f      Filter the CIDs in a car
+   get-block, gb  Get a block out of a car
+   get-dag, gd    Get a dag out of a car
+   index, i       write out the car with an index
+   list, l        List the CIDs in a car
+   verify, v      Verify a CAR is wellformed
+   help, h        Shows a list of commands or help for one command
+```
+
+## Install
+
+To install the latest version of `car` module, run:
+```shell script
+go install github.com/ipld/go-car/cmd/car
+```