Skip to content

Commit 9f55618

Browse files
authored
docs: update README (#194)
- Recommend the `serde_ipld_dagcbor` crate - Update link to chat rooms
1 parent 300e7e5 commit 9f55618

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@
44
55
Originally authored by [@dvc94ch](https://github.com/dvc94ch) as a part of the [ipfs-rust](https://github.com/ipfs-rust/) project.
66

7-
[![Matrix](https://img.shields.io/badge/matrix-%23rust_ipfs%3Amatrix.org-blue.svg)](https://riot.im/app/#/room/#rust-ipfs:matrix.org) [![Discord](https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord)](https://discord.gg/9E5SFvW)
7+
The `Ipld` enum from the `libipld-core` crate is the central piece that most of the users of this library use.
8+
9+
The codec implementations use custom traits. In order to be more compatible with the rest of the Rust ecosystem, it's *strongly recommended*, to use new implementations, that use [Serde](https://serde.rs/) as a basis instead. Currently, the list of implementations is limited, please let us know if you crate one and we'll add it to the list:
10+
11+
- DAG-CBOR: https://github.com/ipld/serde_ipld_dagcbor
12+
13+
## Community
14+
15+
For chats with the developers and the community: Join us in any of these (bridged) locations:
16+
- On Matrix: [#ipld:ipfs.io](https://matrix.to/#/#ipld:ipfs.io)
17+
- On Discord: join the [IPLD community on IPFS Discord](https://discord.gg/xkUC8bqSCP).
818

919
## License
1020

0 commit comments

Comments
 (0)