From 5334a377a48fe31b424b19a6cce79e4d51bae00d Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Tue, 21 May 2019 19:25:06 -0600 Subject: [PATCH] doc updates --- doc.go | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/doc.go b/doc.go index fdbb06b..5e99733 100644 --- a/doc.go +++ b/doc.go @@ -12,20 +12,9 @@ advantage of the features of modern TLS, such as ALPN and SNI See https://telebit.cloud/sclient for more info. -Try the CLI - -If you'd like to better understand what sclient does, you can try it out with `go run`: - - go get git.rootprojects.org/root/sclient.go/cmd/sclient - go run git.rootprojects.org/root/sclient.go/cmd/sclient example.com:443 localhost:3000 - curl http://localhost:3000 -H "Host: example.com" - -Pre-built versions for various platforms are also available at -https://telebit.cloud/sclient - Package Basics -The general use of +In the simplest case you'll just be setting a ServerName and connection info: servername := "example.com" @@ -39,6 +28,16 @@ The general use of err := sclient.DialAndListen() +Try the CLI + +If you'd like to better understand what sclient does, you can try it out with `go run`: + + go get git.rootprojects.org/root/sclient.go/cmd/sclient + go run git.rootprojects.org/root/sclient.go/cmd/sclient example.com:443 localhost:3000 + curl http://localhost:3000 -H "Host: example.com" + +Pre-built versions for various platforms are also available at +https://telebit.cloud/sclient */ package sclient