diff --git a/.gitignore b/.gitignore index ff22f6f..a06aeca 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,8 @@ node_modules -package-lock.json -coverage -.coverage -.nyc_output -docs dist +.docs +.coverage +package-lock.json +yarn.lock go-libp2p-webtransport-server/main diff --git a/README.md b/README.md index 98e681e..59fca5c 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,23 @@ [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/) [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io) [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-webtransport.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-webtransport) -[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-webtransport/test%20&%20maybe%20release/main?style=flat-square)](https://github.com/libp2p/js-libp2p-webtransport/actions/workflows/js-test-and-release.yml) +[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-webtransport/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p-webtransport/actions/workflows/js-test-and-release.yml?query=branch%3Amain) > JavaScript implementation of the WebTransport module that libp2p uses and that implements the interface-transport spec ## Table of contents - [Install](#install) + - [Browser ` +``` + [![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport) [![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection) @@ -67,6 +77,10 @@ For more information see [libp2p/js-libp2p/doc/CONFIGURATION.md#customizing-tran [![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection) +## API Docs + +- + ## License Licensed under either of @@ -74,6 +88,6 @@ Licensed under either of - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) - MIT ([LICENSE-MIT](LICENSE-MIT) / ) -## Contribute +## Contribution 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 98d9c08..8b429f9 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ }, "files": [ "src", - "dist/src", + "dist", "!dist/test", "!**/*.tsbuildinfo" ], @@ -150,7 +150,8 @@ "build": "aegir build", "test": "aegir test -t browser", "test:chrome": "aegir test -t browser --cov", - "release": "aegir release" + "release": "aegir release", + "docs": "aegir docs" }, "dependencies": { "@chainsafe/libp2p-noise": "^11.0.0",