Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Commit

Permalink
docs: update project config to publish api docs (#45)
Browse files Browse the repository at this point in the history
Updates project config to publish api docs
  • Loading branch information
achingbrain authored Jan 12, 2023
1 parent d1613b1 commit bdbf402
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 10 deletions.
9 changes: 4 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,38 @@
[![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 <!-- omit in toc -->

- [Install](#install)
- [Browser `<script>` tag](#browser-script-tag)
- [Description](#description)
- [Usage](#usage)
- [Libp2p Usage Example](#libp2p-usage-example)
- [API](#api)
- [Transport](#transport)
- [Connection](#connection)
- [API Docs](#api-docs)
- [License](#license)
- [Contribute](#contribute)
- [Contribution](#contribution)

## Install

```console
$ npm i @libp2p/webtransport
```

### Browser `<script>` tag

Loading this module through a script tag will make it's exports available as `Libp2pWebtransport` in the global namespace.

```html
<script src="https://unpkg.com/@libp2p/webtransport/dist/index.min.js"></script>
```

[![](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)

Expand Down Expand Up @@ -67,13 +77,17 @@ 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

- <https://libp2p.github.io/js-libp2p-webtransport>

## License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/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.
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
},
"files": [
"src",
"dist/src",
"dist",
"!dist/test",
"!**/*.tsbuildinfo"
],
Expand Down Expand Up @@ -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",
Expand Down

0 comments on commit bdbf402

Please sign in to comment.