Skip to content

Commit b34011d

Browse files
authored
Create README.md
1 parent abc5d88 commit b34011d

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# AndroidPeerRTC
2+
An android library built on top of [PeerRTC](https://github.com/ShimShim27/PeerRTC) module by utilizing the built in WebView module
3+
in android. This library is packed with easy to call api for native android that utilizes peer to peer connection like sending raw text,
4+
sending raw files, audio streaming, video streaming, connecting to peers via unique id and more.
5+
6+
## ❗ Note
7+
* There are no documentations for this library yet. Any contributors are welcome.
8+
* Add credits and attribution to this [repository](https://github.com/ShimShim27/AndroidPeerRTC) when using this library.
9+
* This library is still in beta phase and can be unstable.
10+
* Source code contributions and bug reports are encouraged.
11+
12+
## 📖 Sample Project
13+
* [Video calling app](https://github.com/ShimShim27/AndroidPeerRTC/tree/master/app)
14+
15+
## ⚙️ Setup
16+
17+
1. If you will be using the default PeerRTC backend server provided by us for testing purposes, you can skip this step. For own
18+
managed backend server, refer to [PeerRTC server's](https://github.com/ShimShim27/PeerRTC-Server) repository. Server owned by us is unstable and not managed so it is
19+
recommended to host your own.<br/>
20+
21+
2.
22+

0 commit comments

Comments
 (0)