status-im
/
go-libp2p-webrtc-direct
mirror of https://github.com/status-im/go-libp2p-webrtc-direct.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update readme prior to transferring to libp2p org.

This commit is contained in:
Raúl Kripalani 2019-04-02 13:32:29 +01:00 committed by Raúl Kripalani
parent 537ad79e4d
commit 0fd6f76610
2 changed files with 44 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
.travis.yml Normal file
View File

52
README.md
View File

@ -1,15 +1,51 @@
go-libp2p-webrtc-direct
===
Package ``go-libp2p-webrtc-direct`` is a Go port of [js-libp2p-webrtc-direct](https://github.com/libp2p/js-libp2p-webrtc-direct) that implements the [go-libp2p-transport](https://github.com/libp2p/go-libp2p-transport) interface.
# go-libp2p-webrtc-direct
[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://github.com/libp2p/libp2p)
[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
[![GoDoc](https://godoc.org/github.com/libp2p/go-libp2p-webrtc-direct?status.svg)](https://godoc.org/github.com/libp2p/go-libp2p-webrtc-direct)
[![Coverage
Status](https://coveralls.io/repos/github/libp2p/go-libp2p-webrtc-direct/badge.svg?branch=master)](https://coveralls.io/github/libp2p/go-libp2p-webrtc-direct?branch=master)
[![Build
Status](https://travis-ci.org/libp2p/go-libp2p-webrtc-direct.svg?branch=master)](https://travis-ci.org/libp2p/go-libp2p-webrtc-direct)
> A transport that enables browser-to-server, and server-to-server, direct
> communication over WebRTC without requiring signalling servers. This is the
> Go counterpart to
> [js-libp2p-webrtc-direct](https://github.com/libp2p/js-libp2p-webrtc-direct).
⚠️ Status: Alpha. ⚠️
Lead maintainer: [@backkhem](https://github.com/backkem)
Special thanks to [@pions](https://github.com/pions) for their fantastic
[WebRTC Go library](https://github.com/pions/webrtc), which made this
libp2p transport possible.
## Install
This package supports gomod builds.
```sh
go get github.com/libp2p/go-libp2p-webrtc-direct
```
## Usage
Check out the
[GoDocs](https://godoc.org/github.com/libp2p/go-libp2p-webrtc-direct).
## Examples
Check the [examples](./examples) folder for usage and integration examples.
## Dependencies
There is currently no dependency management technique implemented.
## Contribute
## Status
The package is in alpha status.
Feel free to join in. All welcome. Open an
[issue](https://github.com/libp2p/go-libp2p-webrtc-direct/issues) or send a
PR.
This repository falls under the IPFS [Code of
Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
## License
MIT License - see [LICENSE](LICENSE) for full text
MIT