Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to be more current. #43

Merged
merged 1 commit into from
Apr 24, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions documentation/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ contributing, please read the

- If you aren't just making a documentation change, you'll probably want to learn a bit about a few topics.

- Check out [`/documentations`](https://github.com/goonism/hyperproxy/tree/master/documentations) for information about arbiter's internals
- Check out [`/documentation`](https://github.com/goonism/hyperproxy/tree/master/documentation) for information about Hyperproxy's internals

- When you feel ready to jump into the HyperProxy source code, a good place to start is to look for issues tagged with [help wanted](https://github.com/goonism/hyperproxy/labels/help%20wanted) and/or [good first issue](https://github.com/goonism/hyperproxy/labels/good%20first%20issue).
- When you feel ready to jump into the Hyperproxy source code, a good place to start is to look for issues tagged with [help wanted](https://github.com/goonism/hyperproxy/labels/help%20wanted) and/or [good first issue](https://github.com/goonism/hyperproxy/labels/good%20first%20issue).

## Developing

HyperProxy is built for Node 9 and up.
Hyperproxy is built for Node 9 and up.

Make sure that Yarn is installed with version >= `0.28.0`.
Installation instructions can be found here: https://yarnpkg.com/en/docs/install.
Expand All @@ -51,13 +51,13 @@ $ lerna run start

### Guide on lerna

The following are list of useful root command (command that should be run from the root directory):
The following are a list of useful root commands (commands that should be run from the root directory):

```
"yarn bootstrap": Bootstrap dependency for all modules
"yarn test": Run unit test in each module
"yarn prepare": Prepare all package to publish
"yarn clean": Clean up all local build artifact
"yarn test": Run unit tests in each module
"yarn prepare": Prepare all packages to be publish
"yarn clean": Clean up all local build artifacts
```

### Writing tests
Expand All @@ -67,3 +67,7 @@ Most packages in [`/packages`](https://github.com/hyperproxy/tree/master/package
### Debugging code

A common approach to debugging JavaScript code is to walk through the code using the [Chrome DevTools](https://developers.google.com/web/tools/chrome-devtools/) debugger.

### Submitting a PR

Make sure to run `eslint` on your code before submitting a pull request, please!
6 changes: 3 additions & 3 deletions documentation/rfcs/packges.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# hyperproxy-node
The HyperProxy Node is a node with concept similar to a webtorrent hybrid client. Its main job is to route any given request to the larger TCP/UDP nodes in the DAT ecosystem and return the result back to the original request initiator.
Hyperproxy node is a module that provides proxying capabilities to any WebRTC swarm it is placed in. This means that if you put a Hyperproxy node in your WebRTC swarm pertaining to a specific public key, you are guaranteed a gateway into the Dat ecosystem's native nodes for that same public key.

# hyperproxy-hub
The HyperProxy Hub is a webrtc signalhubws server that is used as a lobby channel for peer to discover each other. In milestone 3, it is also used to ensure that for every peer contacted it, there is at least one hyperproxy-node available to serve that peer request.
The Hyperproxy Hub is a WebRTC Signalhubws server that is used as a lobby channel for peers to discover each other. In addition to being a Signalhubws server, it also automatically creates and injects a Hyperproxy node into each swarm that it creates. This guarantees that any given swarm will have at least one Hyperproxy node.

# hyperproxy-browser
A HyperProxy Browser is a regular WebRTC participant who join the swarm like any other DAT node, used as a test client for plain browser node.
A Hyperproxy Browser is a regular WebRTC participant who joins a swarm like any other DAT node, used as a test client and for marketing purposes to show Hyperproxy in action.