Skip to content
This repository was archived by the owner on Aug 29, 2023. It is now read-only.

Commit 2a0b609

Browse files
authored
docs: update readme (#166)
1 parent 7edad3c commit 2a0b609

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
66
[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
77
[![](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-tcp)
8-
[![](https://img.shields.io/travis/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.com/libp2p/js-libp2p-tcp)
8+
[![Build Status](https://github.com/libp2p/js-libp2p-tcp/actions/workflows/js-test-and-release.yml/badge.svg?branch=main)](https://github.com/libp2p/js-libp2p-tcp/actions/workflows/js-test-and-release.yml)
99
[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-tcp)
1010
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
1111

@@ -23,7 +23,9 @@
2323
- [Transport](#transport)
2424
- [Connection](#connection)
2525
- [Contribute](#contribute)
26+
- [Contribute](#contribute-1)
2627
- [License](#license)
28+
- [Contribution](#contribution)
2729

2830
## Install
2931

@@ -109,6 +111,20 @@ Please be aware that all interactions related to libp2p are subject to the IPFS
109111

110112
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
111113

114+
## Contribute
115+
116+
The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:
117+
118+
- Go through the modules and **check out existing issues**. This is especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
119+
- **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
120+
112121
## License
113122

114-
[MIT](LICENSE) © 2015-2016 David Dias
123+
Licensed under either of
124+
125+
* Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
126+
* MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
127+
128+
### Contribution
129+
130+
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.

0 commit comments

Comments
 (0)