From 2d571d3bc77b1f6aa29d40f3175b382f8cbcb9ce Mon Sep 17 00:00:00 2001 From: David Dias Date: Fri, 20 Oct 2017 12:21:15 +0100 Subject: [PATCH] chore: update documentation --- index.html | 91 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 index.html diff --git a/index.html b/index.html new file mode 100644 index 0000000..8ef5de7 --- /dev/null +++ b/index.html @@ -0,0 +1,91 @@ + +libp2p-websockets - Documentation
libp2p-websockets
0.10.2

Intro

Installable via npm install --save libp2p-websockets, it can also be used directly in the browser.

+

Download

+

The source is available for download from GitHub. Alternatively, you can install using npm:

+
$ npm install --save libp2p-websockets
+

You can then require() libp2p-websockets as normal:

+
const libp2PWebsockets = require('libp2p-websockets')
+

In the Browser

+

Libp2p-websockets should work in any ES2015 environment out of the box.

+

Usage:

+
<script type="text/javascript" src="index.js"></script>
+

The portable versions of libp2p-websockets, including index.js and index.min.js, are included in the /dist folder. Libp2p-websockets can also be found on unkpkg.com under

+ +
\ No newline at end of file