Skip to content
This repository was archived by the owner on Sep 29, 2025. It is now read-only.

Commit 15f3c58

Browse files
committed
docs: better readme
1 parent 3bb121c commit 15f3c58

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@
1515

1616
## Table of Contents
1717

18-
TODO™
18+
- [Install](#install)
19+
- [Usage](#usage)
20+
- [Contribute](#contribute)
21+
- [License](#license)
1922

2023
## Install
2124

@@ -39,24 +42,24 @@ const prefixedProtobuf = multicodec.addPrefix('protobuf', protobufBuffer)
3942
// prefixedProtobuf 0x50...
4043
```
4144

45+
### API
46+
47+
https://multiformats.github.io/js-multicodec/
48+
49+
[multicodec default table](https://github.com/multiformats/multicodec/blob/master/table.csv)
50+
4251
## Updating the lookup table
4352

4453
Updating the lookup table is a manual process. The source of truth is the
4554
[multicodec default table](https://github.com/multiformats/multicodec/blob/master/table.csv). To make the process easier, there’s an [AWK script in the tools directory](tools/update-table.awk) that does a basic conversion of the default table. The result can’t be used as-is, but serves as a template for manual diffing. The workflow is:
4655

4756
- Create a basic draft version
4857

49-
curl -X GET https://raw.githubusercontent.com/multiformats/multicodec/master/table.csv|awk -f tools/update-table.awk > /tmp/draft.js
58+
`curl -X GET https://raw.githubusercontent.com/multiformats/multicodec/master/table.csv|awk -f tools/update-table.awk > /tmp/draft.js`
5059

5160
- Diff it with your tool of choice (e.g. [Meld](http://meldmerge.org/)) and apply the changes
5261

53-
meld /tmp/draft.js base-table.js
54-
55-
## API
56-
57-
https://multiformats.github.io/js-multicodec/
58-
59-
## [multicodec default table](https://github.com/multiformats/multicodec/blob/master/table.csv)
62+
`meld /tmp/draft.js base-table.js`
6063

6164
## Contribute
6265

0 commit comments

Comments
 (0)