GitHub PullRequestReviewCommentEvent at 2014-02-21 19:53:38
Repository: socks-rtc
Actor: iislucas
Payload: {"comment":{"url":"https://api.github.com/repos/uProxy/socks-rtc/pulls/comments/9959264","id":9959264,"diff_hunk":"@@ -9,25 +9,45 @@ This is built on top of [freedom](https://github.com/UWNetworksLab/freedom).\n \n At the moment this only supports chrome.\n \n-### Requirements\n+### Overview\n+\n+There are two modules: _socks-to-rtc_ and _rtc-to-net_.\n+\n+-_socks-to-rtc_ provides a local proxy (which the user could point their browser\n+proxy settings to) which passes requests over a WebRTC peerconnection.\n+-_rtc-to-net_ acts as the 'remote' proxy which receives the requests from the\n+_socks-to-rtc_ peer over WebRTC, passes the request to the destination\n+webserver, and serves the response back to _socks-to-rtc_.\n+\n+#### Requirements\n \n - node + npm\n - grunt `npm install -g grunt-cli`\n \n-### Initial Setup\n+#### Initial Setup\n \n - Run `npm install` from the base directory to obtain all prerequisites.\n - Run `grunt setup` to prepare the freedom installation. (This step should\n   disappear with future versions of freedom)\n-- Run `grunt` which builds everything.\n-- Go to `chrome://extensions`, ensure developer mode is enabled, and load\n-  unpacked extension the `socks-rtc/chrome/` directory.\n-- Open the background page.\n \n-### Build\n-Assuming you've done initial setup:\n-- Run `grunt`.\n-- Reload extension.\n+#### Build\n+- Running `grunt` compiles all the typescript into javascript which goes into\n+  the `build` directory.\n+- If you want to run the example Chrome App, run `grunt chrome`.\n+\n+#### Usage\n+\n+To make use of this library, one needs to include `socks-to-rtc.json` and\n+`rtc-to-net.json`, which are manifests describing freedom modules, as\n+dependencies in the parent application's freedom manifest. Three things must occur\n+for the two components to speak to each other:\n+\n+- `.emit('start')` to _rtc-to-net_ begins the remote peer server.\n+- `.emit('start', { host, port, peerId })` to _socks-to-rtc_ begins listening\n+  locally.\n+- Establish a signalling channel between _rtc-to-net_ and _socks-to-rtc_ so that","path":"README.md","position":50,"original_position":50,"commit_id":"a321cfad63ad18eca297fd4e8553b4f6442eee86","original_commit_id":"a321cfad63ad18eca297fd4e8553b4f6442eee86","user":{"login":"iislucas","id":415450,"avatar_url":"https://gravatar.com/avatar/640a06bb5767daa6d17f9ee000bb8900?d=https%3A%2F%2Fidenticons.github.com%2Feb468047fb8eeb7c41e7ded0493c1d66.png&r=x","gravatar_id":"640a06bb5767daa6d17f9ee000bb8900","url":"https://api.github.com/users/iislucas","html_url":"https://github.com/iislucas","followers_url":"https://api.github.com/users/iislucas/followers","following_url":"https://api.github.com/users/iislucas/following{/other_user}","gists_url":"https://api.github.com/users/iislucas/gists{/gist_id}","starred_url":"https://api.github.com/users/iislucas/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/iislucas/subscriptions","organizations_url":"https://api.github.com/users/iislucas/orgs","repos_url":"https://api.github.com/users/iislucas/repos","events_url":"https://api.github.com/users/iislucas/events{/privacy}","received_events_url":"https://api.github.com/users/iislucas/received_events","type":"User","site_admin":false},"body":"Can you say a tiny bit about how this happens, e.g. done by start calls, or some other call? ","created_at":"2014-02-21T19:53:38Z","updated_at":"2014-02-21T19:53:38Z","html_url":"https://github.com/uProxy/socks-rtc/pull/39#discussion_r9959264","pull_request_url":"https://api.github.com/repos/uProxy/socks-rtc/pulls/39","_links":{"self":{"href":"https://api.github.com/repos/uProxy/socks-rtc/pulls/comments/9959264"},"html":{"href":"https://github.com/uProxy/socks-rtc/pull/39#discussion_r9959264"},"pull_request":{"href":"https://api.github.com/repos/uProxy/socks-rtc/pulls/39"}}}}