Skip to content

Commit

Permalink
Merge pull request #77 from ipfs/notice
Browse files Browse the repository at this point in the history
Add notice directing new projects to codec/dagcbor
  • Loading branch information
warpfork authored Mar 29, 2021
2 parents f689d2b + b4871b4 commit f10507e
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ go-ipld-cbor

> An implementation of a cbor encoded merkledag object.
## Status

This library **has alternatives available**: For new projects, prefer using the [cbor codec](https://github.com/ipld/go-ipld-prime/tree/master/codec/dagcbor) included with [go-ipld-prime](https://github.com/ipld/go-ipld-prime).

This library is in **standby** mode. It works, but we recommend migrating to alternatives if possible. New features are unlikely to be added here.

## Lead Maintainer

[Eric Myhre](https://github.com/warpfork)
Expand All @@ -29,7 +35,7 @@ make install

## Usage

TODO: Right now this package isn't the easiest to use, it will be getting better rapidly, soon.
Note: This package isn't the easiest to use.
```go
// Make an object
obj := map[interface{}]interface{}{
Expand Down

0 comments on commit f10507e

Please sign in to comment.