README.md in multicodecs-0.1.0 vs README.md in multicodecs-0.2.0
- old
+ new
@@ -1,21 +1,27 @@
# Multicodecs
-[![Build Status](https://travis-ci.com/SleeplessByte/ruby-multicodec.svg?token=FpDLv4Yva15pzqYpq9Hk&branch=master)][shield-link-travis]
+[![Build Status](https://travis-ci.com/SleeplessByte/ruby-multicodec.svg?branch=master)][shield-link-travis]
[![Gem Version](https://badge.fury.io/rb/multicodecs.svg)][shield-link-gem]
[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)][shield-link-license]
-[![Maintainability](https://api.codeclimate.com/v1/badges/-/maintainability)][shield-link-codeclimate]
+[![Maintainability](https://api.codeclimate.com/v1/badges/e5b0e892f0c098edd78c/maintainability)][shield-link-codeclimate]
[shield-link-travis]: https://travis-ci.com/SleeplessByte/ruby-multicodec
[shield-link-gem]: https://badge.fury.io/rb/multicodecs
[shield-link-license]: http://opensource.org/licenses/MIT
-[shield-link-codeclimate]: https://codeclimate.com/repos/-/maintainability
+[shield-link-codeclimate]: https://codeclimate.com/github/SleeplessByte/ruby-multicodec/maintainability
> Canonical table of of codecs used by various multiformats
`Multicodecs` is the ruby implementation of [multiformats/multicodec][spec].
+> 🙌🏽 This is called `multicodecs` instead of the singular form, to stay
+> consistent with the `multihashes` gem, which was _forced_ to take a different
+> name has `multihash` was already taken, which is also the case for `multibase`
+> and others. In the future, this might be renamed to `multiformats-codec`, with
+> a backwards-compatible interface.
+
## Installation
Add this line to your application's Gemfile:
```Ruby
@@ -77,10 +83,11 @@
- `Multicodecs.load_csv(csv, radix: 16)`: loads table.csv like data
## Related
- [`multiformats/multicodec`][git-multicodec]: the spec repository
+- [`multiformats/ruby-multiaddr`][git-ruby-multiaddr]: the ruby implementation of [`multiformats/multiaddr`][git-multiaddr]
- [`multiformats/ruby-multibase`][git-ruby-multibase]: the ruby implementation of [`multiformats/multibase`][git-multibase]
- [`multiformats/ruby-multihash`][git-ruby-multihash]: the ruby implementation of [`multiformats/multihash`][git-multihash]
## Development
@@ -114,16 +121,17 @@
The gem is available as open source under the terms of the [MIT License][web-mit].
## Code of Conduct
-Everyone interacting in the Shrine::ConfigurableStorage project’s codebases,
-issue trackers, chat rooms and mailing lists is expected to follow the
-[code of conduct][git-self-coc].
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the [code of conduct][git-self-coc].
[spec]: https://github.com/multiformats/multicodec
[git-self-coc]: https://github.com/SleeplessByte/ruby-multibase/blob/master/CODE_OF_CONDUCT.md
[git-self]: https://github.com/SleeplessByte/ruby-multibase
+[git-ruby-multiaddr]: https://github.com/SleeplessByte/ruby-multiaddr
+[git-multiaddr]: https://github.com/multiformats/multiaddr
[git-ruby-multicodec]: https://github.com/SleeplessByte/ruby-multicodec
[git-multicodec-table]: https://github.com/multiformats/multicodec/blob/master/multicodec.csv
[git-multicodec]: https://github.com/multiformats/multicodec
[git-ruby-multibase]: https://github.com/SleeplessByte/ruby-multibase
[git-multibase]: https://github.com/multiformats/multibase