55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
go-ipld-cbor
|
|
==================
|
|
|
|
[](http://ipn.io)
|
|
[](http://libp2p.io/)
|
|
[](http://webchat.freenode.net/?channels=%23ipfs)
|
|
[](https://coveralls.io/github/libp2p/js-libp2p-floodsub?branch=master)
|
|
[](https://travis-ci.org/libp2p/js-libp2p-floodsub)
|
|
|
|
> An implementation of a cbor encoded merkledag object.
|
|
|
|
|
|
## Table of Contents
|
|
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [API](#api)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
## Install
|
|
|
|
```sh
|
|
make install
|
|
```
|
|
|
|
## Usage
|
|
|
|
TODO: Right now this package isn't the easiest to use, it will be getting better rapidly, soon.
|
|
```go
|
|
// Make an object
|
|
obj := map[interface{}]interface{}{
|
|
"foo": "bar",
|
|
"baz": &Link{
|
|
Target: myCid,
|
|
},
|
|
}
|
|
|
|
// Parse it into an ipldcbor node
|
|
nd, err := WrapMap(obj)
|
|
|
|
fmt.Println(nd.Links())
|
|
|
|
```
|
|
|
|
## Contribute
|
|
|
|
PRs are welcome!
|
|
|
|
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
|
|
|
## License
|
|
|
|
MIT © Jeromy Johnson
|