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.

Sign up for GitHub

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 README.md #561

Merged
merged 1 commit into from
Oct 19, 2020
Merged

Update README.md #561

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
- [Run `hypervisor`](#run-hypervisor)
- [Windows](#windows)
- [Apps](#Apps)
- [Using the Skywire VPN](#using-the-skywire-vpn)
- [App Programming API](#app-programming-api)
- [Transports](#Transports)
- [Creating a GitHub release](#creating-a-github-release)
Expand Down Expand Up @@ -178,7 +179,15 @@ Refer to the following for usage of the apps:
- [Skychat](/cmd/apps/skychat)
- [Skysocks](/cmd/apps/skysocks) ([Client](/cmd/apps/skysocks-client))

### App Programming API
#### Using the Skywire VPN

If you are interested in running the Skywire VPN as either a client or a server, please refer to the following guides:

- [Setup the Skywire VPN](https://github.com/skycoin/skywire/wiki/Setting-up-Skywire-VPN)
- [Setup the Skywire VPN server](https://github.com/skycoin/skywire/wiki/Setting-up-Skywire-VPN-server)


#### App Programming API

Skywire supports building custom apps. In order for visor to run a custom app, app binary should be put into the correct directory. This directory is specified in the visor config as `apps_path`. Each app has a list of parameters:
- `app` (required) - contains application name. This should be equal to the binary name stored in the `apps_path` directory to be correctly resolved by the visor;
Expand Down