diff options
| author | Serene Han <keroserene+git@gmail.com> | 2016-02-24 07:47:17 -0800 |
|---|---|---|
| committer | Serene Han <keroserene+git@gmail.com> | 2016-02-24 07:47:17 -0800 |
| commit | 38999e02de8bc87e5aac5ce074da2e2a9f5b9b02 (patch) | |
| tree | 16fad686aa0be3f0006ca9c7e4ed6ae8bac0f48b /README.md | |
| parent | d4efe774d109b094b81699a608cd1024e096bb64 (diff) | |
| download | snowflake-38999e02de8bc87e5aac5ce074da2e2a9f5b9b02.tar.gz snowflake-38999e02de8bc87e5aac5ce074da2e2a9f5b9b02.zip | |
update README and include TOC
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 22 insertions, 2 deletions
@@ -1,9 +1,23 @@ -# snowflake-pt +# Snowflake [](https://travis-ci.org/keroserene/snowflake) A Pluggable Transport using WebRTC +<!-- START doctoc generated TOC please keep comment here to allow auto update --> +<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> +**Table of Contents** + +- [Status](#status) +- [Usage](#usage) + - [Dependencies](#dependencies) + - [More Info](#more-info) + - [Building a Snowflake](#building-a-snowflake) +- [Appendix](#appendix) + - [-- Testing directly via WebRTC Server --](#---testing-directly-via-webrtc-server---) + - [-- Via Browser Proxy --](#---via-browser-proxy---) + +<!-- END doctoc generated TOC please keep comment here to allow auto update --> ### Status @@ -23,8 +37,14 @@ This should start the client plugin, bootstrapping to 100% using WebRTC. #### Dependencies +Client: - [go-webrtc](https://github.com/keroserene/go-webrtc). -- Go 1.5+ +- Go 1.5.* (1.6 is not yet supported. See [Issue #22](https://github.com/keroserene/snowflake/issues/22)) + +Proxy: +- [CoffeeScript](coffeescript.org) + +--- #### More Info |