README.adoc

=== Nim Socks5 library

image:https://img.shields.io/badge/status-alpha-orange.svg[badge] image:https://img.shields.io/github/tag/FedericoCeratto/nim-socks5.svg[tags] image:https://img.shields.io/badge/License-MPL%20v2-blue.svg[License]

Implement Socks5 client and server with and without authentication.

==== Installation

[source,bash]

nimble install socks5

==== Usage

See the package nim doc

[source,bash]

nim doc socks5.nim

There are also a server and client demo at the bottom of socks5.nim

[source,bash]

nim c --hints:off -d:demoserver -o:server -r socks5.nim

.and: [source,bash]

nim c --hints:off -d:democlient -o:client -r socks5.nim