diff --git a/README.md b/README.md index 26f7e188..e33e872c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![multiformats.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://multiformats.io) [![codecov](https://img.shields.io/codecov/c/github/multiformats/js-multiaddr.svg?style=flat-square)](https://codecov.io/gh/multiformats/js-multiaddr) -[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/multiformats/js-multiaddr/actions/workflows/js-test-and-release.yml) +[![CI](https://img.shields.io/github/workflow/status/multiformats/js-multiaddr/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/multiformats/js-multiaddr/actions/workflows/js-test-and-release.yml) > multiaddr implementation (binary + string representation of network addresses) @@ -16,9 +16,8 @@ - [Usage](#usage) - [API](#api) - [Resolvers](#resolvers) -- [Contribute](#contribute) - [License](#license) -- [Contribution](#contribution) +- [Contribute](#contribute) ## Install @@ -58,7 +57,7 @@ the global namespace. ## Usage ```js -// if we are coming from <= 8.x you can use the factory function +// if we are coming from <= 8.x you can use the factory function const { multiaddr } = require('multiaddr') const addr = multiaddr("/ip4/127.0.0.1/udp/1234") // @@ -76,7 +75,7 @@ addr.toString() // '/ip4/127.0.0.1/udp/1234' addr.protos() -/* +/* [ {code: 4, name: 'ip4', size: 32}, {code: 273, name: 'udp', size: 16} @@ -121,14 +120,6 @@ The available resolvers are: A resolver receives a `Multiaddr` as a parameter and returns a `Promise>`. -## Contribute - -Contributions welcome. Please check out [the issues](https://github.com/multiformats/js-multiaddr/issues). - -Check out our [contributing document](https://github.com/multiformats/multiformats/blob/master/contributing.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). - -Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification. - ## License Licensed under either of @@ -136,6 +127,6 @@ Licensed under either of - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) - MIT ([LICENSE-MIT](LICENSE-MIT) / ) -## Contribution +## Contribute Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. diff --git a/package.json b/package.json index 546ab834..1d909d1b 100644 --- a/package.json +++ b/package.json @@ -91,15 +91,15 @@ "release": "patch" }, { - "type": "chore", + "type": "docs", "release": "patch" }, { - "type": "docs", + "type": "test", "release": "patch" }, { - "type": "test", + "type": "deps", "release": "patch" }, {