Skip to content

Commit 68fcec7

Browse files
docs: add web-wrapper to root README (#414)
* docs: add web-wrapper to root README * make it collapsible * Update README.md
1 parent e45cce6 commit 68fcec7

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,32 @@ The Outline SDK allows you to:
1818
- [Add network-level interference protection to existing apps](#add-the-sdk-to-your-app), such as content or communication apps.
1919
- Troubleshoot connectivity and measure interference with a collection of [command-line tools](#command-line-tools).
2020

21+
## Table of Contents
22+
23+
<details>
24+
<summary>Click to expand</summary>
25+
26+
- [Advantages](#advantages)
27+
- [Interoperable and Reusable](#interoperable-and-reusable)
28+
- [Bypass DNS-based Blocking](#bypass-dns-based-blocking)
29+
- [Bypass SNI-based Blocking](#bypass-sni-based-blocking)
30+
- [Tunnel Connections over a Proxy](#tunnel-connections-over-a-proxy)
31+
- [Build a VPN](#build-a-vpn)
32+
- [Add the SDK to Your App](#add-the-sdk-to-your-app)
33+
- [Generated Mobile Library](#generated-mobile-library)
34+
- [Side Service](#side-service)
35+
- [Go Library](#go-library)
36+
- [Generated C Library](#generated-c-library)
37+
- [Wrap your website in a SDK-enabled App](#wrap-your-website-in-a-sdk-enabled-app)
38+
- [Command-line Tools](#command-line-tools)
39+
- [Resolve a Domain Name](#resolve-a-domain-name)
40+
- [Fetch a Web Page](#fetch-a-web-page)
41+
- [Run a Local Forward Proxy](#run-a-local-forward-proxy)
42+
- [Test Proxy Connectivity](#test-proxy-connectivity)
43+
- [Test Download Speed](#test-download-speed)
44+
45+
</details>
46+
2147
## Advantages
2248

2349
| Multi-Platform | Proven Technology | Composable |
@@ -62,6 +88,7 @@ At the application layer:
6288

6389
- Domain-fronting and SNI hiding with [transport/tls](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/transport/tls)
6490

91+
6592
### Tunnel Connections over a Proxy
6693

6794
The Outline SDK offers two protocols to create connections over proxies:
@@ -88,7 +115,6 @@ The Outline Client uses a **generated mobile library** on Android, iOS and macOS
88115

89116
Below we provide more details on each integration approach. For more details about setting up and using Outline SDK features, see the [Discussions tab](https://github.com/Jigsaw-Code/outline-sdk/discussions).
90117

91-
92118
### Generated Mobile Library
93119

94120
See our [MobileProxy page](./x/mobileproxy/) to learn about the easiest way to integrate the Outline SDK into a mobile app. It runs a local forward proxy that implements resillience strategies that you can use to configure your app's networking libraries.
@@ -138,6 +164,9 @@ Steps:
138164

139165
You can find detailed steps at the tutorial [Go for beginners: Getting started](https://github.com/Jigsaw-Code/outline-sdk/discussions/67).
140166

167+
## Wrap your website in a SDK-enabled App
168+
169+
See our [Web Wrapper example](./x/examples/website-wrapper-app/) for a simple way to package your existing website into a mobile app with built-in resilience features provided by the Outline SDK.
141170

142171
## Command-line Tools
143172

0 commit comments

Comments
 (0)