mirror of
https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git
synced 2025-10-13 20:11:19 -04:00
update README and include TOC
This commit is contained in:
parent
d4efe774d1
commit
38999e02de
1 changed files with 22 additions and 2 deletions
24
README.md
24
README.md
|
@ -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
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue